Installation

Stable release

To install icomo, run this command in your terminal:

$ pip install icomo

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

This is the preferred method to install icomo, as it will always install the most recent stable release. 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 either clone the public repository:

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

Or download the tarball:

$ curl -OJL https://github.com/Priesemann-Group/icomo/tarball/main

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.