The whole project's library can be installed via with the help of setuptools. The project requires Python 3 to run in order for all the functionalities to work, on a Linux based operating system.
- Singularity 3 or greater
- The singularity image for voXSim can be pulled with
singularity pull library://avcaron/default/voxsim_singularity
- The singularity image for voXSim can be pulled with
- MPI libraries
- On Ubuntu, install
openmpi-bin
- On Ubuntu, install
- A good multi-core CPU
- RAM sized to the number of fibers simulated
- ~90ko per fiber at 100 interpolation samples
The project is partially documented; the documentation is generated using sphinx, as well as the
autodoc module. To build the documentation, run the build_documentation.sh script at the base
of the project.
-
Create a python virtual environment (virtualenv, pyenv, etc.) and activate it
-
Install required packages with
pip install -r requirements.txt -
Install the project inside the virtual environment with
python setup.py install -
To install the project as developper, use
pip install -e .orpython setup.py develop