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

Update instances of conda with mamba in docs #3370

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jessica-mitchell
Copy link
Contributor

This PR updates the uses of 'conda' with 'mamba' (not including conda-forge).
The internal requirements for FZJ have changed regarding Anaconda and to mitigate issues we update the docs
to use Mamba instead.
Some text was removed so there's less confusion between Conda and Mamba.

@jessica-mitchell jessica-mitchell added S: High Should be handled next T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Nov 19, 2024
Copy link
Contributor

@steffengraber steffengraber left a comment

Choose a reason for hiding this comment

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

Great job. Only a few changes from my side.

@@ -30,7 +30,7 @@ please follow the guidelines below:

* the steps you took that lead to the problem.
* the specific error messages you get.
* relevant system and version information (e.g., Ubuntu 22.04/ NEST 3.5 installed using the Conda package).
* relevant system and version information (e.g., Ubuntu 22.04/ NEST 3.5 installed using the conda-forge package).
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe use NEST 3.8 instead of NEST 3.5

@@ -32,12 +29,12 @@ Install from source in a conda environment

cd build_dir

* Configure NEST. Add the cmake option ``-CDMAKE_INSTALL_PREFIX:PATH=$CONDA_PREFIX`` to link nest to your active conda environment.
* Configure NEST. Add the cmake option ``-CDMAKE_INSTALL_PREFIX:PATH=$MAMBA_PREFIX`` to link nest to your active mamba environment.
You may need additional ``cmake`` options (see :ref:`cmake_options`).
Copy link
Contributor

Choose a reason for hiding this comment

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

The environment variable is still $CONDA_PREFIX. Maybe on other places, too.

You may need additional ``cmake`` options (see :ref:`cmake_options`).

.. code-block:: sh

cmake -DCMAKE_INSTALL_PREFIX:PATH=$CONDA_PREFIX </path/to/NEST/src>
cmake -DCMAKE_INSTALL_PREFIX:PATH=$MAMBA_PREFIX </path/to/NEST/src>
Copy link
Contributor

Choose a reason for hiding this comment

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

It is still $CONDA_PREFIX.

@@ -4,13 +4,13 @@ Building NEST on macOS
======================

Building NEST on macOS requires some developer tools. There are several sources from
which you can install them, e.g., Conda, Homebrew, or MacPorts. The most important
which you can install them, e.g., Conda-forge, Homebrew, or MacPorts. The most important
Copy link
Contributor

Choose a reason for hiding this comment

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

Please standardise the spelling of conda-forge, without a capital letter at the beginning.

Copy link
Contributor

@steffengraber steffengraber left a comment

Choose a reason for hiding this comment

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

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: High Should be handled next T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Status: Review
Development

Successfully merging this pull request may close these issues.

2 participants