Installation

Installing a user environment

Hint

If it is your first time using Python, we recommend pixi, conda, or uv as easy-to-use package managers. They are available for Windows, macOS, and GNU/Linux. It is always helpful to use dedicated environments.

You can install datarecord via all common package managers:

pixiuvcondapip

pixi add --pypi datarecord

uv add datarecord

conda create -n datarecord "python>=3.12" "pip"
conda activate datarecord
pip install datarecord

pip install datarecord

datarecord is written and tested to be compatible with Python 3.12 and above. We recommend to use the latest version with active support (see endoflife.date).

Installing a development environment

The install instructions are slightly different to create a development environment compared to a user environment:

git clone https://github.com/energy-models/datarecord
cd datarecord

pixi run test    # the test suite
pixi run lint    # ruff, prettier, taplo, typos, zizmor, reuse, mypy

For more detailed instructions specific to developing the datarecord codebase, see the contributing guide.