Installation

The recommended way to install the echemdb is to use your package manager, (e.g., apt-get on Debian or Ubuntu, pacman on Arch Linux, brew on macOS.)

You can consult repology to see if the echemdb is available for your package manager.

Alternatively, the echemdb can be installed by one of the following approaches.

Install with pip from PyPI

The latest stable version of the echemdb is available on PyPI for all platforms and can be installed if you have Python and pip installed already:

pip install echemdb

This command downloads and installs the echemdb and its dependencies into your local Python installation.

If the above command fails because you do not have permission to modify your Python installation, you can install the echemdb into your user account:

pip install --user echemdb

You can instead also install the latest unreleased version of the echemdb from our GitHub Repository with

pip install git+https://github.com/echemdb/echemdb@main

Install with conda from conda-forge

The echemdb is available on conda-forge for all platforms.

If you don’t have conda yet, we recommend to install Miniforge.

Miniforge is already pre-configured for conda-forge. If you already had another release of conda installed, make sure the conda-forge channel is configured correctly

Once your conda setup is ready, create a new echemdb environment with the latest stable version of the echemdb:

conda create -n echemdb echemdb

To use the echemdb, activate the echemdb environment:

conda activate echemdb

To install the echemdb into an existing environment, activate that environment and then

conda install echemdb

Install with pip for development

If you want to work on the echemdb itself, get a copy of the latest unreleased version of the echemdb:

git clone https://github.com/echemdb/echemdb.git

Create an editable install of the echemdb:

pip install -e echemdb

Any changes you make to the files in your local copy of the echemdb should now be available in your next Python session.

We would love to see your contribution to the echemdb.