Add instructions for configuring a spack-stack based python environment #1367
Conversation
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
…ack environments" instructions.
…d python virtual environment.
climbfuji
reviewed
Nov 6, 2024
| @@ -5,6 +5,14 @@ Using spack-stack environments | |||
|
|
|||
| The following tutorial assumes you have a functioning spack-stack environment installed local to your system. This environment is provided on platforms described in :numref:`Section %s <Preconfigured_Sites>`. If you intend to run spack-stack on your developer machine or on a new platform, you can create an environment using the steps described in :numref:`Section %s <NewSiteConfigs>`. | |||
|
|
|||
| There are three steps in setting up a usable development environment. | |||
| The first is to load the spack-stack environment and the second is to create a python virtual environment that is based on the python executable included within the spack-stack installation. | |||
There was a problem hiding this comment.
Might be useful to mention here that as many as possible of the spack-stack Python modules (not just the executable) should be loaded when using/installing additional packages in the virtual environment.
There was a problem hiding this comment.
Also, when you push updates, please include [skip ci] in the commit message - no need to run the tests for doc updates only.
There was a problem hiding this comment.
Added a note encouraging the use of the spack-stack installed python modules.
climbfuji
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Instructions are added to the UsingSpackEnvironments.rst showing how to configure and use a consistent python virtual environment based on spack-stack.
Testing
Built html on my Mac laptop and verified that the new instructions are rendered properly.
Applications affected
Documentation only update
Systems affected
Documentation only update
Dependencies
None
Issue(s) addressed
Resolves #1302
Checklist