Skip to main content

Introduction

This is the documentation on the diffsim project. diffsim contains a collection of methods for simulating diffusion MRI data.

Implemented methods​

  • Monte Carlo simulation

Installation​

Environment​

Run mamba env create -f environment.yaml to create a mamba environment. Activate the environment with mamba activate diffsim. Run pip install -e .[dev] or make install-dev to install the package.

Environment variables​

Required variables are set in the required_env_vars.json file. Variables that need to be set are:

  • "BASE_PATH": path from where paths of path_config are built and also outputs are stored
  • "DATA_PATH": path to where the data is stored