-
Notifications
You must be signed in to change notification settings - Fork 11
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 installation instructions to use miniforge #375
Conversation
docs/installation.rst
Outdated
@@ -19,6 +18,13 @@ initialize a new conda environment (for example, named ``cubids``) as follows: | |||
$ conda create -n cubids python=3.12 pip |
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.
We should probably remove all the conda references. Could you please delete this section?
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.
Should I also change the 'conda install deno' chunk to 'mamba install deno' ? @mattcieslak
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.
I think that should work.
@B-Sevchik in the current installation instructions, there's a bit that starts "Alternatively, you can clone the source code..." I would recommend making a new section starting at that point named "For developers" since the only folks who will clone the repo and install the package in editable mode are developers (not regular users). |
installing if you want to contribute code (are a developer): |
@B-Sevchik I just realized that the installation instructions for developers are in https://github.com/PennLINC/CuBIDS/blob/main/CONTRIBUTING.rst. Maybe instead of duplicating those instructions in the installation guide you could just add a line linking to the contributors guide? Something like... .. tip::
If you want to modify the CuBIDS codebase
(e.g., if you are looking to contribute to CuBIDS),
please follow the installation instructions in
`our contributing guidelines <https://github.com/PennLINC/CuBIDS/blob/main/CONTRIBUTING.rst>`_. |
Oh, okay got it, I'll edit the change I just made to link to those, thanks @tsalo ! |
Can you also update the contributing file to use miniforge instead of venv? |
Yes, will do! |
The changes are looking good, but I still see conda mentioned a few times where we probably want mamba. I also don't have the best handle on how miniforge and mamba are related. We might need to link to the mamba installation documentation as well. @smeisler does that sound right? |
I'll go over it with @B-Sevchik a bit later |
added some changes |
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.
Just a couple of small things.
Co-authored-by: Taylor Salo <[email protected]>
Co-authored-by: Taylor Salo <[email protected]>
Partially closes #363 .
(not sure how would be best to break down installation instructions whether you are user or dev)
Changes proposed in this pull request
Documentation that should be reviewed