ENH: add ctrlenv-shell and document it#340
Open
ZLLentz wants to merge 2 commits into
Open
Conversation
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
1 participant
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.
Description
Add one more ctrlenv helper function:
ctrlenv-shellThis activates a centrally installed pixi environment in a exitable/deactivatable subshell
Unlike
ctrlenv-activate, which cannot be deactivated, this can be deactivated.Unlike
ctrlenv-activate, which is safe to include in a script, this cannot be included in a script.The behavior is extremely similar to the
pixi shellfunction, but implementing it this way means the user isn't required to have pixi on their path to usectrlenv-shell.I've also fixed some typos in the script docstring.
Motivation and Context
@aberges-SLAC requested a tool that would allow him to deactivate the pixi environments, as we used to be able to do with conda. This should satisfy those requirements.
How Has This Been Tested?
Interactively only.
Where Has This Been Documented?
In comments and the README.