Installation

Stable release

To install icomo, run this command in your terminal:

$ pip install icomo

To run all the examples, you might also want to install the optional dependencies:

$ pip install icomo[opt]

You might want to create a virtual environment first, e.g. using mamba:

$ mamba create -n icomo_env icomo
$ mamba activate icomo_env

or directly using venv:

$ python -m venv /path/to/new/icomo_env
$ source /path/to/new/icomo_env/bin/activate
$ pip install icomo

You might also want to install jupyterlab to run the examples:

$ pip install jupyterlab

From sources

The sources for icomo can be downloaded from the Github repo.

You can clone the public repository:

$ git clone https://github.com/Priesemann-Group/icomo

Enter the directory and install with pip:

$ cd icomo
$ pip install -e .

This enables you to edit the code and have the changes directly available in your python environment. To include the optional and development dependencies, use:

$ cd icomo
$ pip install -e .[dev]