Downloads
=========

The SDK is published as one eight-package release on TestPyPI. Install it from
TestPyPI rather than installing individual wheel files:

- `Install the SDK from TestPyPI <https://test.pypi.org/>`_
- :download:`Download the SDK wheel archive for offline use (ZIP) <_static/downloads/mimic-sdk-wheels.zip>`

TestPyPI installation
---------------------

.. important::

   Use Python 3.10 and a fresh virtual environment. The Waymo package must be
   installed with ``--no-deps`` because its old dependency pins conflict with
   the shared SDK environment.

1. Install ``uv`` if it is not already available on your machine. For example:

   .. code-block:: bash

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

   After installation, open a new terminal so the ``uv`` command is available on your ``PATH``.

2. Create a Python 3.10 environment:

   .. code-block:: bash

      uv venv --python 3.10 .venv
      source .venv/bin/activate

3. Install all eight MIMIC packages from TestPyPI and public PyPI:

   .. code-block:: bash

      uv pip install \
         --index-url https://test.pypi.org/simple/ \
         --extra-index-url https://pypi.org/simple/ \
         qvyon-mimic-filesystem qvyon-mimic-data-api qvyon-mimic-raillabel \
         qvyon-mimic-wod qvyon-mimic-nuscene qvyon-mimic-kitti360 \
         qvyon-mimic-osdar23 qvyon-mimic-pandaset
      uv pip install --no-deps waymo-open-dataset-tf-2-11-0==1.6.1
      uv pip install dacite==1.8.1 typeguard==4.4.4

4. Verify that converter commands are available in the active environment:

   .. code-block:: bash

      command -v kitti360-convert
      command -v osdar23-convert
      command -v nuscene-convert
      command -v wod-convert

Offline ZIP installation is retained only for environments that cannot access
TestPyPI. Extract the archive and follow the same package order using the local
wheel files.