diff --git a/README.md b/README.md index 23b788e..d979f3a 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,17 @@ This project contains everything needed to build and update the neuro-forge packages. neuro-forge is a set of packages for the Conda ecosystem dedicated to image analysis and data analysis in neuroimaging. -## How to create a workspace and install neuro-forge packages - neuro-forge is still in early alpha stage and should only be used for testing. +## Prerequisite +Most action with neuro-forge requires to [install Pixi](https://pixi.sh). It is a binary without dependency to put somewhere in the PATH. If you want to avoid the use of the script proposed by Pixi team (that install in `~/.pixi/bin` and changes `~/.bashrc`), you can download the latest release of `pixi`executable for Linux x86_64 achitecture with the following command: + +``` +curl -fsSL https://github.com/prefix-dev/pixi/releases/latest/download/pixi-x86_64-unknown-linux-musl.tar.gz | tar zx +``` + +## How to create a workspace directory and install neuro-forge packages + neuro-forge packages are contained in a Conda channel located in https://brainvisa.info/neuro-forge (this is a temporary URL, it may change at any moment). They can be installed using [Pixi](https://pixi.sh), [Mamba](https://mamba.readthedocs.io) or [Conda](https://docs.conda.io). We recommand the use of pixi. For instance, once pixi is installed, one can use the following script to setup a workspace containing anatomist: ``` @@ -34,7 +41,7 @@ The creation of packages for neuro-forge is based on the use of [rattler-build]( - [soma-forge packages](https://github.com/neurospin/neuro-forge/tree/main/soma-forge) that are packages from the [BrainVISA](https://brainvisa.info) project and requires a soma-forge development environement to be build. -In order to build a neuro-forge channel from scratch, one must use pixi. The following script will create a `channel` directory containing the base packages that are necessary to complement conda-forge in order to build other packages. +In order to build a neuro-forge channel from scratch, one must use pixi. The following script will create a `channel` directory containing the base packages that are necessary to build other packages but are not in coda-forge. ``` git clone https://github.com/neurospin/neuro-forge @@ -42,7 +49,7 @@ cd neuro-forge pixi run neuro-forge init channel ``` -## How to create a BrainVISA development directory with soma-forge +## How to create a soma-forge development workspace First install soma-forge command that is located in neuro-forge project. ``` @@ -62,3 +69,13 @@ cd /somewhere/brainvisa-py3.11-cap2-qt5 pixi shell bv_maker ``` + +## soma-forge packages + +The packages currently built have the following dependencies: +- green: package containing brainvisa-cmake components ; +- olive: empty package with dependencies ; +- bisque: neuro-forge base package ; +- light blue: package from conda-forge. + +![dependencies](https://github.com/brainvisa/soma-forge/assets/3062350/c34edacd-ec27-49b4-b68d-75505390d63b)