This package provides tools to process and handle battery cycler experimental data. Examples on how to run this package can be found in the examples folder

pip install virtualenv

The module dependencies are listed in pyproject.toml, the dependancies which are non optional which are installed with the package.

The optional dependencies are split into dev and docs. dev are used for testing and linting, docs are used for building the sphinx documentation.

1. Create a virtual environment (this is strongly recommended to avoid clashes with the dependencies)

   virtualenv --python="<path to python 3.11>" env

2. Activate the virtual environment

   source env/bin/activate

   The virtual environment can later be deactivated (if needed) by running

   deactivate

3. Install packages into the virtual environment

   pip install -e ./[dev,docs]

1. Create a virtual environment (this is strongly recommended to avoid clashes with the dependencies)

   python -m virtualenv env

2. Activate the virtual environment

   env\Scripts\activate.bat

   The virtual environment can later be deactivated (if needed) by running

   deactivate

3. Install package

   pip install -e .\\[dev,docs]