Installation#

Pre-requisites#

Espresso requires Python 3.6+, and the following dependencies:

  • numpy>=1.18

  • scipy>=1.0.0

  • matplotlib>=3.1

Virtual environment setup#

It’s optional, but recommended to use a virtual environment.

Ensure you have python>=3.6.

To create:

python -m venv <path-to-new-env>/esp_env

To activate:

source <path-to-new-env>/esp_env/bin/activate

To exit:

deactivate

To remove:

rm -rf <path-to-new-env>/esp_env

To create:

virtualenv <path-to-new-env>/esp_env -p=3.10

To activate:

source <path-to-new-env>/esp_env/bin/activate

To exit:

deactivate

To remove:

rm -rf <path-to-new-env>/esp_env

To create:

conda create -n esp_env python=3.10

To activate:

conda activate esp_env

To exit:

conda deactivate

To remove:

conda env remove -n esp_env

Install#

pip install cofi-espresso

Uploading to conda-forge is still work in progress.

It won’t be long!

If you’d like to build from source, clone the repository

git clone https://github.com/inlab-geo/espresso.git
cd espresso

And use either one of the following command to install

pip install .         # library will be copied over to site-packages
pip install -e .      # developer mode, library will be symbol linked to site-packages