Installation

The recommended way to install the unitpackage 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 unitpackage is available for your package manager.

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

Install with pip from PyPI

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

pip install unitpackage

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

pip install --user unitpackage

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

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

Install with conda from conda-forge

The unitpackage 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 unitpackage environment with the latest stable version of the unitpackage:

conda create -n unitpackage

To use the unitpackage, activate the unitpackage environment:

conda activate unitpackage

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

conda install unitpackage

Install with pip for development

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

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

Move to the directory and install the dependencies

conda activate unitpackage
conda env create --file environment.yaml

Create an editable install of the unitpackage:

pip install -e unitpackage

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

We would love to see your contribution to the unitpackage.