Hugging Face's logo

Datasets:
hc99
/
FEA-Bench

Dataset card Files
xet
Community
FEA-Bench / testbed /Project-MONAI__MONAI /docs /source /installation.md
hc99's picture
hc99
Add files using upload-large-folder tool
5ccd75a verified
preview code
|
raw
history blame contribute delete
5.36 kB

Installation guide

MONAI's core functionality is written in Python 3 (>= 3.6) and only requires Numpy and Pytorch.

The package is currently distributed via Github as the primary source code repository, and the Python package index (PyPI). The pre-built Docker images are made available on DockerHub.

This page provides steps to:

To install optional features such as handling the NIfTI files using Nibabel, or building workflows using Pytorch Ignite, please follow the instructions:

From PyPI

To install the current milestone release:

pip install monai

From GitHub

(If you have installed the PyPI release version using pip install monai, please run pip uninstall monai before using the commands from this section. Because pip by default prefers the milestone release.)

The milestone versions are currently planned and released every few months. As the codebase is under active development, you may want to install MONAI from GitHub for the latest features:

Option 1 (as a part of your system-wide module): 

pip install git+https://github.com/Project-MONAI/MONAI#egg=MONAI

this command will download and install the current master branch of MONAI from GitHub.

This documentation website by default shows the information for the latest version.

Option 2 (editable installation):

To install an editable version of MONAI, it is recommended to clone the codebase directly:

git clone https://github.com/Project-MONAI/MONAI.git

This command will create a MONAI/ folder in your current directory. You can install it by running:

cd MONAI/
python setup.py develop

# to uninstall the package please run:
python setup.py develop --uninstall

or simply adding the root directory of the cloned source code (e.g., /workspace/Documents/MONAI) to your $PYTHONPATH and the codebase is ready to use (without the additional features of MONAI C++/CUDA extensions).

Validating the install

You can verify the installation by:

python -c 'import monai; monai.config.print_config()'

If the installation is successful, this command will print out the MONAI version information, and this confirms the core modules of MONAI are ready-to-use.

MONAI version string

The MONAI version string shows the current status of your local installation. For example:

MONAI version: 0.1.0+144.g52c763d.dirty
  • 0.1.0 indicates that your installation is based on the 0.1.0 milestone release.
  • +144 indicates that your installation is 144 git commits ahead of the milestone release.
  • g52c763d indicates that your installation corresponds to the git commit hash 52c763d.
  • dirty indicates that you have modified the codebase locally, and the codebase is inconsistent with 52c763d.

From DockerHub

Make sure you have installed the NVIDIA driver and Docker 19.03+ for your Linux distribution. Note that you do not need to install the CUDA toolkit on the host, but the driver needs to be installed. Please find out more information on nvidia-docker.

Assuming that you have the Nvidia driver and Docker 19.03+ installed, running the following command will download and start a container with the latest version of MONAI. The latest master branch of MONAI from GitHub is included in the image.

docker run --gpus all --rm -ti --ipc=host projectmonai/monai:latest

You can also run a milestone release docker image by specifying the image tag, for example:

docker run --gpus all --rm -ti --ipc=host projectmonai/monai:0.1.0

Installing the recommended dependencies

By default, the installation steps will only download and install the minimal requirements of MONAI. Optional dependencies can be installed using the extras syntax to support additional features.

For example, to install MONAI with Nibabel and Scikit-image support:

git clone https://github.com/Project-MONAI/MONAI.git
cd MONAI/
pip install -e '.[nibabel,skimage]'

Alternatively, to install all optional dependencies:

git clone https://github.com/Project-MONAI/MONAI.git
cd MONAI/
pip install -e '.[all]'

To install all optional dependencies for MONAI development:

git clone https://github.com/Project-MONAI/MONAI.git
cd MONAI/
pip install -r requirements-dev.txt

Since MONAI v0.2.0, the extras syntax such as pip install 'monai[nibabel]' is available via PyPI.

  • The options are
[nibabel, skimage, pillow, tensorboard, gdown, ignite, torchvision, itk]

which correspond to nibabel, scikit-image, pillow, tensorboard, gdown, pytorch-ignite, torchvision, and itk respectively.

  • pip install 'monai[all]' installs all the optional dependencies.