Skip to content

Commit 377a573

Browse files
YLouWashUmeta-codesync[bot]
authored andcommitted
{Documentation} Adding intro page to projectaria-tools.
Summary: This diff adds a intro page for projectaria_tools. Reviewed By: kongchen1992 Differential Revision: D84951849 fbshipit-source-id: a2ee9ae2ebc82aac4ca1e00c1f4a5dc6722179f2
1 parent aa23265 commit 377a573

File tree

11 files changed

+66
-28
lines changed

11 files changed

+66
-28
lines changed

website/docs-ark/mps/start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Note that if the above command emits some error, please refer to the [troublesho
5454

5555
Project Aria MPS CLI is only available if you install the pip installation version of Project Aria MPS. This installation has been designed to be simple to use, even if you are not familiar with programming languages.
5656
:::info Dependencies
57-
Project Aria MPS pypi package automatically installs the [projectaria-tools](/research-tools/projectariatools/start#installing) package and [projectaria-vrs-health-check](/ark/vrs_health_check/installation#installing-vrs-health-check) package
57+
Project Aria MPS pypi package automatically installs the [projectaria-tools](/research-tools/projectariatools/installation#installing) package and [projectaria-vrs-health-check](/ark/vrs_health_check/installation#installing-vrs-health-check) package
5858
:::
5959

6060
## Supported Platforms

website/docs-ark/vrs_health_check/installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ rm -rf $HOME/projectaria_gen2_python_env
1919
python3 -m venv $HOME/projectaria_gen2_python_env
2020
source $HOME/projectaria_gen2_python_env/bin/activate
2121

22-
python3 -m pip install projectaria-tools-vrs-health-check
22+
python3 -m pip install projectaria-vrs-health-check
2323
```
2424
</TabItem>
2525
<TabItem value="windows" label="Windows">

website/docs-research-tools/osi.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Choose your starting point based on your research goals:
7575
Begin with the [Aria Gen 2 Pilot Dataset](/research-tools/dataset/pilot/content) to explore available data. Then follow the [Download Guide](/research-tools/dataset/pilot/download) to access the dataset and start your research.
7676

7777
### For Tool Users
78-
Install [Project Aria Tools](/research-tools/projectariatools/start) to work with Aria data. The library provides Python APIs and tutorials for loading, visualizing, and processing VRS files.
78+
Install [Project Aria Tools](/research-tools/projectariatools/installation) to work with Aria data. The library provides Python APIs and tutorials for loading, visualizing, and processing VRS files.
7979

8080
### For Algorithm Developers
8181
Explore the Open Models section to access pre-trained models and algorithms. Use them as baselines or building blocks for your own research.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
{
22
"label": "Project Aria Tools",
3-
"position": 0
3+
"position": 0,
4+
"link": {
5+
"type": "doc",
6+
"id": "projectariatools/overview"
7+
}
48
}

website/docs-research-tools/projectariatools/advanced-installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This page covers advanced installation options to build Project Aria Tools from
1414

1515

1616
## Pre-requisites: install dependencies {#prerequisites}
17-
Before proceed to any of the advanced installation steps, please follow the command in [the installer widget on Quick Start page](/docs-research-tools/projectariatools/start.mdx#installing) to pull the correct branch from Github.
17+
Before proceed to any of the advanced installation steps, please follow the command in [the installer widget on Quick Start page](/docs-research-tools/projectariatools/installation.mdx#installing) to pull the correct branch from Github.
1818

1919
Then install the following third party dependency lib:
2020
```mdx-code-block

website/docs-research-tools/projectariatools/start.mdx renamed to website/docs-research-tools/projectariatools/installation.mdx

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_position: 0
3-
title: Get Started
3+
title: Installation
44
---
55

66
import React, { useEffect, useMemo, useState } from "react";
@@ -29,16 +29,3 @@ Use the above table to get the exact command to install `projectaria-tools` libr
2929
| macOS (Apple Silicon / ARM64) | macOS **14+ (Sonoma or newer)** on M1/M2/M3 | ✅ Supported | 3.10 – 3.12 |
3030
| macOS (Intel) | macOS **13+ (Ventura or newer)** | ✅ Supported | 3.8 – 3.12 |
3131
| Windows (x64) | MSVC **2019/2022** | 🚧 Planned | 3.10 – 3.12 |
32-
33-
34-
35-
## Python Notebook Tutorials
36-
37-
Proceed to the following Python notebook tutorials to learn how to use the Python APIs to consume Aria data:
38-
- [Tutorial 1: VrsDataProvider Basics](/docs-research-tools/projectariatools/pythontutorials/dataprovider.mdx): how to perform basic operations in loading and access data in an Aria VRS file.
39-
- [Tutorial 2: Device Calibration](/docs-research-tools/projectariatools/pythontutorials/calibration.mdx): how to work with device calibration in Aria VRS.
40-
- [Tutorial 3: Queued Sensor Data](/docs-research-tools/projectariatools/pythontutorials/queue.mdx): how to use the unified queued API to efficiently “stream” multi-sensor data.
41-
- [Tutorial 4: On-Device Eye Tracking and Hand Tracking](/docs-research-tools/projectariatools/pythontutorials/eyetracking-handtracking.mdx): how to work with on-device-generated EyeGaze and Hand-tracking signals from Aria Gen2 glasses.
42-
- [Tutorial 5: On-Device VIO](/docs-research-tools/projectariatools/pythontutorials/vio.mdx): how to work with on-device-generated VIO data from Aria Gen2 glasses.
43-
- [Tutorial 6: Timestamp Mapping in Single- and Multi-Device Recordings](/docs-research-tools/projectariatools/pythontutorials/time-sync.mdx): understanding timestamp mapping in Aria data, and how to use timestamp mapping in multi-device recording.
44-
- [Tutorial 7: Machine Perception Services (MPS) Data Loading](/docs-research-tools/projectariatools/pythontutorials/mps.mdx): how to load and visualize output data from Aria MP.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
sidebar_position: 0
3+
title: Project Aria Tools Overview
4+
---
5+
6+
# Project Aria Tools
7+
8+
`projectaria-tools` is the official library for accessing and processing data recorded by **Project Aria glasses**.
9+
It provides a unified interface to load VRS files and access all associated sensor and machine perception data through high-level, easy-to-use APIs.
10+
The library supports efficient operations such as random access, timestamp-based queries, and synchronized multi-sensor data retrieval, with a consistent set of **C++ and Python APIs** seamlessly bridged via Pybind11.
11+
12+
Project Aria glasses record its data in **VRS** (Visual Recordings System) format, which is a general-purpose recording format from Meta.
13+
Properly interpreting Project Aria VRS requires detailed understanding of the device’s sensor configurations, calibration models, and on-device perception outputs.
14+
`projectaria-tools` abstracts these complexities, ensuring that all data is correctly parsed, aligned, and represented for research and development workflows.
15+
16+
In addition to data access, the library includes visualization and conversion utilities that allow users to inspect and export selected streams to standard formats such as CSV and MP4, making it easier to analyze and share Aria data across diverse toolchains.
17+
18+
## Getting Started
19+
20+
If you're new to `proejctaria-tools`, start here:
21+
22+
- **[Quick Start Installation Guide](./installation.mdx)** - Learn how to install `projectaria-tools` on your system
23+
- **[Advanced Installation](./advanced-installation.mdx)** - Advanced installation options and configurations
24+
- **[Pixi Installation](./advanced-installation-pixi.mdx)** - Install using Pixi package manager
25+
26+
27+
## Python Notebook Tutorials
28+
29+
Explore our comprehensive Python tutorials to learn how to work with Aria data:
30+
31+
- [Tutorial 1: VrsDataProvider Basics](/docs-research-tools/projectariatools/pythontutorials/dataprovider.mdx): how to perform basic operations in loading and access data in an Aria VRS file.
32+
- [Tutorial 2: Device Calibration](/docs-research-tools/projectariatools/pythontutorials/calibration.mdx): how to work with device calibration in Aria VRS.
33+
- [Tutorial 3: Queued Sensor Data](/docs-research-tools/projectariatools/pythontutorials/queue.mdx): how to use the unified queued API to efficiently “stream” multi-sensor data.
34+
- [Tutorial 4: On-Device Eye Tracking and Hand Tracking](/docs-research-tools/projectariatools/pythontutorials/eyetracking-handtracking.mdx): how to work with on-device-generated EyeGaze and Hand-tracking signals from Aria Gen2 glasses.
35+
- [Tutorial 5: On-Device VIO](/docs-research-tools/projectariatools/pythontutorials/vio.mdx): how to work with on-device-generated VIO data from Aria Gen2 glasses.
36+
- [Tutorial 6: Timestamp Mapping in Single- and Multi-Device Recordings](/docs-research-tools/projectariatools/pythontutorials/time-sync.mdx): understanding timestamp mapping in Aria data, and how to use timestamp mapping in multi-device recording.
37+
- [Tutorial 7: Machine Perception Services (MPS) Data Loading](/docs-research-tools/projectariatools/pythontutorials/mps.mdx): how to load and visualize output data from Aria MP.
38+
39+
40+
## Visualization Tools
41+
42+
Tools for visualizing and exploring Aria data:
43+
44+
- **[Python Visualization](./tools/pythonviz.mdx)** - Python-based visualization
45+
- **[C++ Visualization](./tools/cppviz.mdx)** - C++ visualization tool
46+
- **[VRS to MP4](./tools/vrstomp4.mdx)** - Convert VRS recordings to MP4 video
47+
- **[Export to CSV](./tools/exportcsv.mdx)** - Export sensor data to CSV format

website/docs-research-tools/projectariatools/pythontutorials/calibration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ ray_3d = camera_calib.unproject(test_pixel)
214214
print(f"Pixel {test_pixel} unprojected to -> 3D ray {ray_3d}")
215215
```
216216

217-
## Camera Intrinsics: undistortion
217+
### Camera Intrinsics: undistortion
218218

219219
Camera calibration enables post-processing of Aria images, such as undistorting images from a fisheye to a linear camera model. Steps:
220220

website/docs-technical-specs/vrs/useful-tools.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ title: Useful VRS Tools
55

66
# Useful VRS Tools
77

8-
* The most intuitive way to access Aria VRS files is via the tools (and APIs) shipped in [`projectaria-tools` library](/research-tools/projectariatools/start), which includes tools to [visualize Aria VRS](/research-tools/projectariatools/tools/pythonviz), [convert to MP4](/research-tools/projectariatools/tools/vrstomp4), and [export to other data format](/research-tools/projectariatools/tools/exportcsv).
8+
* The most intuitive way to access Aria VRS files is via the tools (and APIs) shipped in [`projectaria-tools` library](/research-tools/projectariatools/installation), which includes tools to [visualize Aria VRS](/research-tools/projectariatools/tools/pythonviz), [convert to MP4](/research-tools/projectariatools/tools/vrstomp4), and [export to other data format](/research-tools/projectariatools/tools/exportcsv).
99
* Users can inspect the data quality of Aria VRS file using [`VrsHealthCheck`](/ark/vrs_health_check/installation), which is a tool that we specially tailored for Aria VRS recordings.
1010
* Users can also choose to use [the native tool provided by the `VRS` library](https://facebookresearch.github.io/vrs/) to perform some simple actions on the VRS file, including inspecting basic data information, extracting to images or audio files, etc. But please note that the `VRS` library needs to be [built with H.265 decoding support](https://github.com/facebookresearch/vrs#build--run-with-h265-hevc-decoding-support-macos--linux) in order to properly handle Aria Gen2 VRS files.

website/docs/intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Project Aria’s offering to the research community is organized into two major
6969

7070
- **[Open Datasets](/research-tools/dataset/pilot/content):** Explore and download egocentric datasets
7171
- **Pre-trained Models:** Use and fine-tune state-of-the-art models for your research. Coming soon
72-
- **[Project Aria Tools](/research-tools/projectariatools/start):** Python libraries and utilities for working with Aria data
72+
- **[Project Aria Tools](/research-tools/projectariatools/installation):** Python libraries and utilities for working with Aria data
7373

7474
---
7575

0 commit comments

Comments
 (0)