Skip to content

Commit

Permalink
Merge pull request #59 from CBICA/spiros-dev
Browse files Browse the repository at this point in the history
[Bug] Minor fix to headers on installation rst file
  • Loading branch information
AlexanderGetka-cbica authored Dec 6, 2024
2 parents 195946e + 1ef43fc commit ef522a9
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ You can build the package by running the following command: ::

$ docker build -t cbica/nichart_dlmuse .

.. _`Singularity/Apptainer build`
***************************
Singularity/Apptainer build
***************************

Singularity and Apptainer images can be built for NiChart_DLMUSE, allowing for frozen versions of the pipeline and easier
installation for end-users. Note that the Singularity project recently underwent a rename to "Apptainer", with a commercial
Expand All @@ -43,13 +45,16 @@ After installing the container engine, run: ::
This will take some time, but will build a containerized version of your current repo. Be aware that this includes any local changes!
The nichart_dlmuse.sif file can be distributed via direct download, or pushed to a container registry that accepts SIF images.

.. _`Manual installation`
*******************
Manual installation
*******************

You can manually build the package from source by running: ::

$ git clone https://github.com/CBICA/NiChart_DLMUSE

$ cd NiChart_DLMUSE && python3 -m pip install -e .

We **do not** recomment installing the package directly from source as the repository above is under heavy development and can cause
crashes and bugs.
.. note::
We **do not** recommend installing the package directly from source as the repository above is under heavy development and can cause
crashes and bugs.

0 comments on commit ef522a9

Please sign in to comment.