MIMIC Data API Documentation
============================

Welcome to the MIMIC Data API documentation. This library provides data structures
for representing driving scenes, including sensor data (cameras, LiDARs, radars),
actors (vehicles, pedestrians, cyclists), and trajectories.

The Data API is designed for:

- **Serialization**: Easy JSON export/import for data exchange
- **Simulation**: Providing ground truth for rendering and replay
- **Analysis**: Querying and filtering scene elements
- **Interoperability**: Working with various autonomous driving datasets

For dataset-conversion playbooks and TestPyPI customer onboarding, use
the **User Guides** section in this documentation.

Start Here
----------

If you are new to this SDK, start with the TestPyPI installation and then follow the guides in order:

1. :doc:`Downloads <downloads>`
2. :doc:`Getting Started <customer/README>`
3. :doc:`Using Converted Data <customer/converted-data-sdk>`
4. :doc:`MIMIC Data Converter <customer/conversion-guide>`
5. :doc:`MIMIC Data API <customer/quick-reference>`
6. :doc:`MIMIC Data Validation <customer/validation-guide>`
7. :doc:`ROS Bag Conversion <customer/ros-bag-conversion>`


What Each Page Helps With
-------------------------

**Downloads**

- :doc:`Downloads <downloads>`: Install the published SDK from TestPyPI in a uv environment.

**User Guides**

- :doc:`Getting Started <customer/README>`: Setup flow, package overview, and which converter package to install first.
- :doc:`Using Converted Data <customer/converted-data-sdk>`: Load converted scenes with the SDK and check referenced sensor files.
- :doc:`MIMIC Data Converter <customer/conversion-guide>`: End-to-end conversion workflow from raw dataset to MIMIC scene output.
- :doc:`ROS Bag Conversion <customer/ros-bag-conversion>`: Read ROS1/ROS2 bags and map PointCloud2 data to MIMIC LiDAR PLY.
- :doc:`MIMIC Data API <customer/quick-reference>`: Practical API snippets for scene creation, loading, and common coding tasks.
- :doc:`MIMIC Data Validation <customer/validation-guide>`: Validation checklist and scripts to catch schema/data issues before delivery.

**API CONTENTS**

- :doc:`API Brief Description <getting_started>`: High-level model and conventions summary.
- :doc:`Data Structures <data_structures>`: Core object model, field meanings, and relationships.
- :doc:`Examples <examples>`: Usage examples for common operations.

**API Reference**

- :doc:`Scene Module <api/scene>`: Scene, ego vehicle, and sensors container models.
- :doc:`Trajectory Module <api/trajectory>`: Timestamped trajectory and motion-related model details.
- :doc:`Camera Module <api/camera>`: Camera intrinsics/extrinsics and image metadata definitions.
- :doc:`LiDAR Module <api/lidar>`: LiDAR intrinsics, point-cloud metadata, and lidar-specific constraints.
- :doc:`Radar Module <api/radar>`: Radar intrinsics and radar point-cloud metadata definitions.
- :doc:`Actor Module <api/actor>`: Actor dimensions, labels, and actor trajectory models.

**Resources**

- :doc:`JSON Schema Reference <json_schema>`: Schema-style examples for major objects and fields.
- :doc:`Example Scene <example_scene>`: A complete scene example to use as a reference output.


.. toctree::
   :maxdepth: 1
   :caption: Downloads:
   :hidden:

   downloads


.. toctree::
   :maxdepth: 2
   :caption: User Guides:
   :hidden:

   customer/README
   customer/converted-data-sdk
   customer/conversion-guide
   customer/ros-bag-conversion
   customer/quick-reference
   customer/validation-guide

.. toctree::
   :maxdepth: 2
   :caption: API CONTENTS:
   :hidden:

   getting_started
   data_structures
   examples

.. toctree::
   :maxdepth: 2
   :caption: API Reference:
   :hidden:

   api/scene
   api/trajectory
   api/camera
   api/lidar
   api/radar
   api/actor

.. toctree::
   :maxdepth: 1
   :caption: Resources:
   :hidden:

   json_schema
   example_scene