Skip to content

Commit 70bc4f4

Browse files
B-Sevchiktsalo
andauthored
Update installation instructions to use miniforge (#375)
* update installation instructions to use miniforge * edit miniforge installation instructions to specify which sections are for developers * edited CONTRIBUTING.rst instructions to use miniforge instead of venv * link to contributors guide in installation.rst * fixed weird formatting error in installation.rst * Update docs/installation.rst Co-authored-by: Taylor Salo <[email protected]> * Update docs/installation.rst Co-authored-by: Taylor Salo <[email protected]> --------- Co-authored-by: Taylor Salo <[email protected]> Co-authored-by: Taylor Salo <[email protected]>
1 parent 3025315 commit 70bc4f4

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

CONTRIBUTING.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ Ready to contribute? Here's how to set up `cubids` for local development.
6363

6464
$ git clone [email protected]:your_name_here/cubids.git
6565

66-
3. Install your local copy into a virtualenv.
67-
Assuming you have virtualenvwrapper installed,
68-
this is how you set up your fork for local development::
66+
3. Install your local copy into a miniforge environment.
67+
This is how you set up your fork for local development::
6968

70-
$ mkvirtualenv cubids
69+
$ mamba create -n cubids python=3.12
70+
$ mamba activate cubids
7171
$ cd cubids/
7272
$ python setup.py develop
7373

docs/installation.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@ Installation
88

99
.. note::
1010
We **strongly recommend** using ``CuBIDS`` with environment management.
11-
For this, we recommend `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_
12-
(`miniforge <https://github.com/conda-forge/miniforge>`_ for M1 Chip Mac Machines).
11+
For this, we recommend `miniforge <https://github.com/conda-forge/miniforge>`_.
1312

14-
Once you've installed conda,
15-
initialize a new conda environment (for example, named ``cubids``) as follows:
13+
Once you've installed mamba,
14+
initialize a new mamba environment (for example, named ``cubids``) as follows:
1615

1716
.. code-block:: console
1817
19-
$ conda create -n cubids python=3.12 pip
20-
$ conda activate cubids
18+
$ mamba create -n cubids python=3.12 pip
19+
$ mamba activate cubids
2120
2221
You are now ready to install CuBIDS.
2322
You can do so in one of two ways.
@@ -29,8 +28,7 @@ To obtain ``CuBIDS`` locally, we can use ``pip`` to download our software from t
2928
3029
$ pip install CuBIDS
3130
32-
Alternatively,
33-
you can clone the source code for ``CuBIDS`` from our `GitHub repository`_ using the following command:
31+
Alternatively, you can clone the source code for ``CuBIDS`` from our `GitHub repository`_ using the following command:
3432

3533
.. code-block:: console
3634
@@ -43,13 +41,14 @@ Once you have a copy of the source, you can install it with:
4341
$ cd CuBIDS
4442
$ pip install -e .
4543
44+
4645
We will now need to install some dependencies of ``CuBIDS``.
4746
To do this, we first must install deno to run `bids-validator`.
4847
We can accomplish this using the following command:
4948

5049
.. code-block:: console
5150
52-
$ conda install deno
51+
$ mamba install deno
5352
5453
The new schema-based ``bids-validator`` doesn't need to be installed
5554
and will be implemented automatically when `cubids validate` is called
@@ -75,6 +74,13 @@ and will be implemented automatically when `cubids validate` is called
7574
7675
For more information, you can read: https://bids-validator.readthedocs.io/en/latest/user_guide/command-line.html
7776

77+
.. tip::
78+
If you want to modify the CuBIDS codebase
79+
(e.g., if you are looking to contribute to CuBIDS),
80+
please follow the installation instructions in
81+
`our contributing guidelines <https://github.com/PennLINC/CuBIDS/blob/main/CONTRIBUTING.rst>`_.
82+
83+
7884
We also recommend using ``CuBIDS`` with the optional ``DataLad`` version control capabilities.
7985
We use ``DataLad`` throughout our walkthrough of the CuBIDS Workflow on
8086
:doc:`the Example Walkthrough page <example>`.

0 commit comments

Comments
 (0)