Skip to content

Installation#

There are a few different ways to install elicito. We provide these by use case below. As a short summary, if you:

By use case#

As a library#

If you want to use elicito as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below.

The (non-locked) version of elicito can be installed with conda for macOS and Linux and with pip for Windows, macOS and Linux.

# only for macOS and Linux
conda install conda-forge::elicito

# for macOS, Linux, and Windows
pip install elicito

Additional dependencies can be installed using

If you are installing with conda, we recommend installing the extras by hand because there is no stable solution yet (see conda issue #7502)

# To add all optional dependencies
pip install 'elicito[full]'

# To add plotting dependencies
pip install 'elicito[plots]'

# To add scipy dependency
pip install 'elicito[scipy]'

# To add pandas dependency
pip install 'elicito[pandas]'

For developers#

For development, we rely on uv for all our dependency management. To get started, you will need to make sure that uv is installed (instructions here (we found that the self-managed install was best, particularly for upgrading uv later).

For all of our work, we use our Makefile. You can read the instructions out and run the commands by hand if you wish, but we generally discourage this because it can be error prone. In order to create your environment, run make virtual-environment.

If there are any issues, the messages from the Makefile should guide you through. If not, please raise an issue in the issue tracker.

For the rest of our developer docs, please see development.