Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added command to Install for adding conda forge as a channel #409

Merged
merged 3 commits into from
Feb 6, 2025

Conversation

dean-krueger
Copy link
Contributor

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 the Install: header of the sidebar to include conda config --add channels conda-forge which will add conda forge as a channel to the users conda env.

Closes #404

@dean-krueger dean-krueger requested a review from gonuke January 17, 2025 21:15
Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair criticism! The install page instructs to include the channel in the install command.

@@ -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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Copy link
Contributor Author

@dean-krueger dean-krueger Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

@dean-krueger dean-krueger requested a review from gonuke January 23, 2025 19:42
Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this fix @dean-krueger

@gonuke
Copy link
Member

gonuke commented Feb 2, 2025

Looks like this has a merge conflict, then I'm happy to merge

@dean-krueger
Copy link
Contributor Author

This should be fixed as well. Let me know if not.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@gonuke
Copy link
Member

gonuke commented Feb 6, 2025

This became out of date again, but I just had Github try to fix it - once tests are successful, I'll merge

@gonuke gonuke merged commit 9e26836 into cyclus:source Feb 6, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incomplete sidebar cyclus install instructions
2 participants