Have WSL users install graphviz system wide #2144
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amarkpayne
added
Complexity: Low
Good First Issue
Platform: Windows
Status: Ready for Review
Codecov Report
@@ Coverage Diff @@
## master #2144 +/- ##
==========================================
+ Coverage 47.39% 47.45% +0.06%
==========================================
Files 89 89
Lines 23995 23995
Branches 6258 6258
==========================================
+ Hits 11372 11387 +15
+ Misses 11418 11407 -11
+ Partials 1205 1201 -4
Continue to review full report at Codecov.
|
|
Thanks for the review @jonwzheng ! I'll rebase to update this branch. If you don't mind approving this PR after the test pass again, I'll merge this in |
The graphviz conda package does not supply these dependencies, so they have to be installed manually or system wide. Since these dependencies could change over time, it is easier to install this system wide rather than constantly update the dependency list on our end. Note: libxrender1 is a dependency of graphviz, and thus installed together.
amarkpayne
force-pushed
the
wsl_install_deps
branch
from
c0aaa20 to
433a403
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation or Problem
fixes #2141 . The graphviz dependency requires many render libraries to work properly. Unfortunately, these dependencies are not listed by this package, so conda does not
install them in the conda environment. Instead, the system wide libraries are used if
available. On most native Linux distro like Ubuntu, these libraries are installed by default.
However, these libraries are not installed by default in WSL versions of Ubuntu. This
means that WSL users are missing dependencies that they need to run many RMG
related scripts and features.
Description of Changes
Updated WSL installation documentation to prompt user to install the graphviz package system wide. This is preferred over figuring out which dependencies graphviz needs that
are not currently installed by default, as these could change over time. In an ideal world
conda would deal with this for us, but the graphviz conda package does not do this, though
there appears to be some future work towards this end (see the discussion in #2141).
Testing
I have confirmed that this solution works in a fresh WSL install, and this also fixed the
user's problem in #2141. I have also built the documentation locally to ensure the changes
look as desired.
Reviewer Note
libxrender1 is a dependency of graphviz, and thus installed
together.