Installation

Install with pip from PyPI

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

pip install echemdbconverters

This command downloads and installs the echemdbconverters 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 echemdbconverters into your user account:

pip install --user echemdbconverters

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

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

Install with pip for development

If you want to work on the echemdbconverters itself, install pixi and get a copy of the latest unreleased version of the echemdbconverters:

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

To launch the echemdbconverter, run:

pixi run echemdbconverters

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

To build the documentation locally, run

pixi run doc

and to run all doctests, run

pixi run doctest

We would love to see your contribution to the echemdbconverters.