Installation

hdhelpers requires Python 3.12 or newer and is included in the hetida designer runtime. To use it in your own Python project, run the following commands in your project’s Python environment.

Core package

Install the metadata and time zone helpers:

python -m pip install hdhelpers

For a project managed with uv, use uv add hdhelpers instead. The core package works without Plotly.

Plotting helpers

Install the optional plotting extra to use hdhelpers.plotting and the plotting functions exported by hdhelpers:

python -m pip install "hdhelpers[plotting]"

With uv, use uv add "hdhelpers[plotting]". This also enables from hdhelpers import *, which includes plotting exports.

Verify the installation

python -c "import hdhelpers; print(hdhelpers.__version__)"

Continue with First steps for component examples or Metadata examples for sample pandas data to use in a Python session.