-
Notifications
You must be signed in to change notification settings - Fork 370
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
jessica-mitchell
wants to merge
2
commits into
nest:master
Choose a base branch
from
jessica-mitchell:update-conda-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,58 @@ | ||
.. _conda_forge_install: | ||
|
||
Conda forge install | ||
conda-forge install | ||
=================== | ||
|
||
.. admonition:: osx-arm64: missing random number generators | ||
|
||
Due to a cross-compiling issue in the conda NEST package, some random number | ||
generators are not available if you are using macOS arm64 architecture. | ||
Due to a cross-compiling issue in the conda-forge NEST package, some random number | ||
generators are not available if you are using macOS arm64 architecture. | ||
The available generators are the Mersenne Twister generators `mt19937` and `mt19937_64`. | ||
|
||
.. note:: | ||
|
||
If you encounter problems installing the NEST conda package and | ||
environment, we recommend using Mamba (https://mamba.readthedocs.io). | ||
We recommend using Mamba (https://mamba.readthedocs.io). | ||
Mamba has the advantage of installing conda packages and | ||
environments more quickly and can be used as a complete drop-in replacement for conda. | ||
|
||
1. To keep your conda setup tidy, we recommend that you install NEST into | ||
a separate `conda environment <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`_ | ||
1. To keep your mamba setup tidy, we recommend that you install NEST into | ||
a separate environment | ||
together with Python packages that you will use when working with NEST; | ||
see also our :ref:`conda_tips`. | ||
|
||
To install the latest version of NEST in a new environment called ``ENVNAME``, just run | ||
|
||
.. code-block:: sh | ||
|
||
conda create --name ENVNAME -c conda-forge nest-simulator | ||
mamba create --name ENVNAME -c conda-forge nest-simulator | ||
|
||
To install additional packages into the environment, just list them together with ``nest-simulator``. | ||
|
||
.. code-block:: sh | ||
|
||
conda create --name ENVNAME -c conda-forge nest-simulator jupyterlab seaborn | ||
mamba create --name ENVNAME -c conda-forge nest-simulator jupyterlab seaborn | ||
|
||
#. To see all NEST versions available via conda, either run | ||
|
||
.. code-block:: sh | ||
|
||
conda search -c conda-forge nest-simulator | ||
mamba search -c conda-forge nest-simulator | ||
|
||
or browse the `conda forge file list | ||
<https://anaconda.org/conda-forge/nest-simulator/files>`_ (note | ||
there are multiple pages). To install, e.g., NEST 2.18.0, run | ||
To install a specific version e.g., NEST 2.18.0, run | ||
|
||
.. code-block:: sh | ||
|
||
conda create --name nest_2_18_0 -c conda-forge nest-simulator=2.18.0=* | ||
mamba create --name nest_2_18_0 -c conda-forge nest-simulator=2.18.0=* | ||
|
||
The syntax for this install follows the pattern: ``nest-simulator=<version>=<build_string>``. | ||
|
||
#. Activate your environment: | ||
|
||
.. code-block:: sh | ||
|
||
conda activate ENVNAME | ||
mamba activate ENVNAME | ||
|
||
#. Note the following: | ||
|
||
- We currently provide NEST with thread-based parallelization on conda. This should suffice for most | ||
- We currently provide NEST with thread-based parallelization on conda-forge. This should suffice for most | ||
uses on personal computers. |
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
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.