Skip to content

Installation

Note

h5pack requires Python 3.10 or newer.

Install using pip

The easiest way to install h5pack is through pip by running:

pip install h5pack

After installing h5pack you can verify the installation by running:

h5pack --version

This should output:

h5pack version x.y.z yyyy-zzzz developed by Esteban Gómez (Speech Interaction Technology, Aalto University)

Where:

  • x.y.z represents the major, minor, and patch version.
  • yyyy-zzzz indicates the development start year and the current year.

Optional features

Some features need additional packages, which can be installed as an extra:

Extra Installs Needed for
play sounddevice Playing audio with h5pack show --play

For example:

pip install "h5pack[play]"

Install using uv

uv is a modern python package manager. You can see more details about uv in the official documentation.

First, you need to install uv and uvx following the instructions for your operating system in uv website.

Then run:

uv tool install h5pack

You can verify the installation running:

uv tool run h5pack --version

or you can use the shortcut version uvx:

uvx h5pack --version

This should output:

h5pack version x.y.z yyyy-zzzz developed by Esteban Gómez (Speech Interaction Technology, Aalto University)

Where:

  • x.y.z represents the major, minor, and patch version.
  • yyyy-zzzz indicates the development start year and the current year.

What's next

Now that you have installed h5pack, check the Quickstart section to begin using it.