Added command to Install for adding conda forge as a channel #409
Conversation
This file contains 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
gonuke
requested changes
Jan 18, 2025
source/atemplates/sidebar.html
Outdated
| @@ -23,7 +23,7 @@ <h3>Get Cyclus</h3> | |||
| Current version: <b>1.6.0</b> | |||
| <br><br> | |||
| Install: | |||
| <div class="highlight-bash" style="width:97.5%"><div class="highlight"><pre><span class="nv">$ </span>conda install cyclus cycamore</pre></div></div> | |||
| <div class="highlight-bash" style="width:97.5%"><div class="highlight"><pre><span class="nv">$ </span>conda config --add channels conda-forge<br><span class="nv">$ </span>conda install cyclus cycamore</pre></div></div> | |||
There was a problem hiding this comment.
This is a little simpler, maybe?
Suggested change
| <div class="highlight-bash" style="width:97.5%"><div class="highlight"><pre><span class="nv">$ </span>conda config --add channels conda-forge<br><span class="nv">$ </span>conda install cyclus cycamore</pre></div></div> | |
| <div class="highlight-bash" style="width:97.5%"><div class="highlight"><span class="nv">$ </span>conda install -c conda-forge cyclus cycamore</pre></div></div> |
There was a problem hiding this comment.
I super agree that this is simpler. I didn't know you could combine the commands like that! I'll make the change. You forgot an opening <pre> tag, though, so I'll make the commit from my machine to make sure that nice little white box shows up around the command (otherwise it would just display as text on the yellow sidebar background and look funny).
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.
Previously the instructions just said to
conda install cyclus cycamore, but made no mention of that only being available on the conda forge channel. For experienced users, this may be obvious to troubleshoot, but for people newer to conda (undergrads, new grad students, people who don't do a lot of coding, etc) this provides a frustrating bottleneck. This PR updates the commands under theInstall:header of the sidebar to includeconda config --add channels conda-forgewhich will add conda forge as a channel to the users conda env.Closes #404