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

Installation docs assume conda-forge channel already in conda config #126

Closed
mcs07 opened this issue Nov 30, 2021 · 1 comment · Fixed by #130
Closed

Installation docs assume conda-forge channel already in conda config #126

mcs07 opened this issue Nov 30, 2021 · 1 comment · Fixed by #130
Labels
joss-review OpenCADD-KLIFS JOSS review

Comments

@mcs07
Copy link

mcs07 commented Nov 30, 2021

It's really great that you have a package on conda-forge for easy installation!

This might be a bit of an edge case, but if users install mamba into an existing conda install (e.g. from Miniconda or Anaconda), they won't automatically get the conda-forge channel pre-configured (like it would be from a mambaforge install). In this case, the installation instructions as written won't work.

It could be worth extending the existing "Note" about mamba to mention this, for example:

If you installed mamba into an existing conda installation, also make sure that the conda-forge channel is configured by running conda config --add channels conda-forge.

Link to JOSS review: openjournals/joss-reviews#3951

@dominiquesydow
Copy link
Contributor

Hi @mcs07,

Thanks a lot for this suggestion! I have added the suggested note to our documentation.
Would you like to take a look before I merge?
#130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
joss-review OpenCADD-KLIFS JOSS review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants