Skip to content
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

Merged
merged 9 commits into from
Jan 23, 2025

Conversation

B-Sevchik
Copy link
Contributor

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

@@ -19,6 +18,13 @@ initialize a new conda environment (for example, named ``cubids``) as follows:
$ conda create -n cubids python=3.12 pip
Copy link
Contributor

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?

Copy link
Contributor Author

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

Copy link
Member

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.

@tsalo
Copy link
Member

tsalo commented Jan 15, 2025

@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).

@singlesp
Copy link
Contributor

singlesp commented Jan 15, 2025

installing if you want to contribute code (are a developer):
pip install -e .[all]

@tsalo
Copy link
Member

tsalo commented Jan 16, 2025

@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>`_.

@B-Sevchik
Copy link
Contributor Author

Oh, okay got it, I'll edit the change I just made to link to those, thanks @tsalo !

@tsalo
Copy link
Member

tsalo commented Jan 16, 2025

Can you also update the contributing file to use miniforge instead of venv?

@B-Sevchik
Copy link
Contributor Author

Yes, will do!

@tsalo tsalo added documentation Improvements or additions to documentation maintenance labels Jan 16, 2025
@B-Sevchik B-Sevchik requested a review from tsalo January 16, 2025 17:08
@tsalo
Copy link
Member

tsalo commented Jan 16, 2025

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?

@smeisler
Copy link
Contributor

I'll go over it with @B-Sevchik a bit later

@smeisler
Copy link
Contributor

added some changes

Copy link
Member

@tsalo tsalo left a 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.

docs/installation.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
B-Sevchik and others added 2 commits January 17, 2025 10:06
@tsalo tsalo changed the title update installation instructions to use miniforge Update installation instructions to use miniforge Jan 17, 2025
@tsalo tsalo merged commit 70bc4f4 into PennLINC:main Jan 23, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use miniforge in installation instructions
5 participants