Add venv option for source installation in docs#3710
Open
jessica-mitchell wants to merge 2 commits intonest:masterfrom
Open
Add venv option for source installation in docs#3710jessica-mitchell wants to merge 2 commits intonest:masterfrom
venv option for source installation in docs#3710jessica-mitchell wants to merge 2 commits intonest:masterfrom
Conversation
jessica-mitchell
added
T: Maintenance
terhorstd
reviewed
Jan 23, 2026
terhorstd
reviewed
Jan 23, 2026
terhorstd
reviewed
Jan 23, 2026
Comment on lines
+78
to
+84
| For your convenience, a shell script setting all required environment variables is provided in | ||
| ``<nest_install_dir>/bin/nest_vars.sh``. Setting the environment variables in your active shell session requires | ||
| sourcing the script: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| source <nest_install_dir>/bin/nest_vars.sh |
Contributor
There was a problem hiding this comment.
The nest_vars.sh is not necessary when installing into an environment (venv, conda, mamba, etc.), as long as CMAKE_INSTALL_PREFIX was not specified in the cmake command. The activation of the envrionment source venv/bin/activate is exactly what source …/bin/nest_vars.sh does when NEST is installed outside an environment.
Co-authored-by: Dennis Terhorst <terhorstd@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds another option besides no environment and mamba for using source install
@terhorstd need to check dependencies, as nestbuildmatrix and noenv were quite different.
Assumes readline and libncurses is not needed (expecting pynest-ng)