From 4e78742e55b9870794c93daf67ba6717d8736a01 Mon Sep 17 00:00:00 2001 From: clementpoiret Date: Tue, 29 Oct 2024 09:20:21 +0100 Subject: [PATCH] doc: updated readme --- README.rst | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e2fd3bd..7bcedc1 100644 --- a/README.rst +++ b/README.rst @@ -107,13 +107,43 @@ The API syntax retakes sklearn's API syntax, with a ``RoiLocator`` class, having ants.image_write(right_seg, "./sub00_hippocampus_right.nii.gz") ants.image_write(left_seg, "./sub00_hippocampus_left.nii.gz") +Development Environment +*********************** + +ROILoc relies on Nix_ and Devenv_. + +.. _Nix: https://nixos.org/download/ +.. _Devenv: https://devenv.sh + +**Step 1**: Install Nix_: +:: + + sh <(curl -L https://nixos.org/nix/install) --daemon + +**Step 2**: Install Devenv_: +:: + + nix-env -iA devenv -f https://github.com/NixOS/nixpkgs/tarball/nixpkgs-unstable + +**Step 3**: +:: + + devenv shell + +That's it :) + +If you want something even easier, install direnv_ and +allow it to automatically activate the current env (``direnv allow``). + +.. _direnv: https://direnv.net/ + Installation ************ 1/ Be sure to have a working ANTs installation: `see on GitHub `_, -2/ Simply run ``pip install roiloc`` (at least python 3.7). +2/ Simply run ``pip install roiloc`` (at least python 3.9). Example: