Installation

You can run NDK without installing the package using docker, as shown here. However, if you'd like to install it, please follow the instructions below.

Before installing on Windows

Install Ubuntu on WSL.
Follow the the Linux steps described in this page inside your Ubuntu shell.

neurotechdevkit requires Python >=3.9 and <3.11 to be installed. You can find which Python version you have installed by running python --version in a terminal.

If you don't have Python installed, or you are running an unsupported version, you can download it from python.org. Python environment managers like pyenv, conda, and poetry are all perfectly suitable as well.

Before installing on Linux

In order to install neurotechdevkit you must first install g++ and the python-dev package for your python version.

Both packages can be installed with:
```
apt-get install -y g++ python3.10-dev
```
Important: You must replace 3.10 with your python version when running the command above.

You can install the neurotechdevkit package using:

pip install neurotechdevkit

You also have to install stride, it can be done running:

pip install git+https://github.com/trustimaging/stride@2520c59

Setting up a compiler

NDK uses devito to perform the heavy computational operations. Devito generates, compiles and runs C code to achieve better performance. The compiler used by Devito has to be selected, and paths for the linker might also be added as environment variables.

As a last step before running NDK, follow the instructions below depending on your OS.

Before running on MacOS

The single compiler option for MacOS is clang.

clang

To setup your environment you will have to install libomp and llvm, you will also have to export a few environment variables needed by the compiler.

Install libomp
```
brew install libomp
```
Run the following command to export a new environment variable CPATH with the path for libomp headers:
```
echo 'export CPATH="'$(brew --prefix)'/opt/libomp/include"' >> ~/.zshrc
```
Install llvm:
```
brew install llvm
```

Run the following commands to export the llvm environment variables:

echo 'export PATH="'$(brew --prefix)'/opt/llvm/bin:$PATH"' >> ~/.zshrc
echo 'export LDFLAGS="-L'$(brew --prefix)'/opt/llvm/lib"' >> ~/.zshrc
echo 'export CPPFLAGS="-I'$(brew --prefix)'/opt/llvm/include"' >> ~/.zshrc

The following command will export the DEVITO_ARCH environment variable:
```
echo 'export DEVITO_ARCH="clang"' >> ~/.zshrc
```
Load the modified zsh configuration file:
```
source ~/.zshrc
```

Before running on Linux

Export the DEVITO_ARCH environment variable, or add it to your shell profile:
```
export DEVITO_ARCH="gcc"
```
The supported values for DEVITO_ARCH are: 'custom', 'gnu', 'gcc', 'clang', 'aomp', 'pgcc', 'pgi', 'nvc', 'nvc++', 'nvidia', 'cuda', 'osx', 'intel', 'icpc', 'icc', 'intel-knl', 'knl', 'dpcpp', 'gcc-4.9', 'gcc-5', 'gcc-6', 'gcc-7', 'gcc-8', 'gcc-9', 'gcc-10', 'gcc-11'.

Note

After installing neurotechdevkit you can use Jupyter to explore the package.

To get started, we recommend downloading the example notebooks from this link.

On Linux you can download and extract the notebooks running the following commands:

sudo apt-get update && sudo apt-get install -y unzip wget
wget "http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip