Skip to content
8 changes: 4 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ Ready to contribute? Here's how to set up `cubids` for local development.

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

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

$ mkvirtualenv cubids
$ mamba create -n cubids python=3.12
$ mamba activate cubids
$ cd cubids/
$ python setup.py develop

Expand Down
20 changes: 13 additions & 7 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,15 @@ Installation

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

Once you've installed conda,
initialize a new conda environment (for example, named ``cubids``) as follows:

.. code-block:: console

$ conda create -n cubids python=3.12 pip
$ conda activate cubids
$ mamba create -n cubids python=3.12 pip
$ mamba activate cubids

You are now ready to install CuBIDS.
You can do so in one of two ways.
Expand All @@ -29,8 +28,7 @@ To obtain ``CuBIDS`` locally, we can use ``pip`` to download our software from t

$ pip install CuBIDS

Alternatively,
you can clone the source code for ``CuBIDS`` from our `GitHub repository`_ using the following command:
Alternatively,you can clone the source code for ``CuBIDS`` from our `GitHub repository`_ using the following command:

.. code-block:: console

Expand All @@ -43,18 +41,26 @@ Once you have a copy of the source, you can install it with:
$ cd CuBIDS
$ pip install -e .


We will now need to install some dependencies of ``CuBIDS``.
To do this, we first must install deno to run `bids-validator`.
We can accomplish this using the following command:

.. code-block:: console

$ conda install deno
$ mamba install deno

The new schema-based ``bids-validator`` doesn't need to be installed
and will be implemented automatically when `cubids validate` is called


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


We also recommend using ``CuBIDS`` with the optional ``DataLad`` version control capabilities.
We use ``DataLad`` throughout our walkthrough of the CuBIDS Workflow on
:doc:`the Example Walkthrough page <example>`.
Expand Down
Loading