Skip to content

Get Started

It is highly recommended to install in a virtual environment to keep your system in order.

The following command installs the latest version of the library:

# pip
pip install minrecord

# uv
uv pip install minrecord

To make the package as slim as possible, only the packages required to use minrecord are installed. It is possible to install all the optional dependencies by running the following command:

# pip
pip install 'minrecord[all]'

# uv
uv pip install 'minrecord[all]'

This command also installed NumPy and PyTorch. It is also possible to install the optional packages manually or to select the packages to install. In the following example, only NumPy is installed:

pip install minrecord numpy

Installing from source

To install minrecord from source, you can follow the steps below. First, you will need to install uv. uv is used to manage and install the dependencies. If uv is already installed on your machine, you can skip this step. You can install uv by running:

curl -LsSf https://astral.sh/uv/install.sh | sh

You can check the uv installation by running the following command:

uv --version

Then, you can clone the git repository:

git clone git@github.com:durandtibo/minrecord.git
cd minrecord

It is recommended to create a Python 3.10+ virtual environment. This step is optional so you can skip it. You can use uv to create a virtual environment:

make setup-venv
source .venv/bin/activate

This example uses uv to create a virtual environment, but you can use other tools or configurations. Then, you should install the required package to use minrecord with the following command:

inv install

This command will install all the required packages. You can also use this command to update the required packages. This command will check if there is a more recent package available and will install it. Finally, you can test the installation with the following command:

inv unit-test --cov