wehub-resource-sync
79 lines
2.7 KiB
Markdown
79 lines
2.7 KiB
Markdown
---
|
|
title: Getting Started
|
|
order: 1
|
|
---
|
|
|
|
Rerun helps robotics and Physical AI teams iterate faster: log from any sensor, visualize in the Viewer, query with dataframes, and train with a dataloader tailored to robotic learning — across one recording or many.
|
|
|
|
## Installation
|
|
|
|
`pip install rerun-sdk[dataplatform, dataloader]` bundles the **SDK** (log/query from code) and the **Viewer** (visualizer app). The optional dependencies support queries and training below.
|
|
For Rust, C++, see [Install Rerun](./getting-started/install-rerun.md) and [Set up a project](./getting-started/project-setup.md).
|
|
|
|
## Open the Viewer
|
|
|
|
`rerun` launches the Viewer.
|
|
Pass a file to open it directly:
|
|
|
|
```bash
|
|
rerun path/to/recording.rrd
|
|
```
|
|
|
|
Supports `.rrd`, `.mcap`, and [more](./getting-started/data-in/open-any-file.md).
|
|
Also available in-browser at [rerun.io/viewer](https://rerun.io/viewer).
|
|
|
|
|
|
## Scale across many recordings
|
|
|
|
Rerun's catalog organizes recordings as queryable [**segments**](./concepts/query-and-transform/catalog-object-model.md).
|
|
The workflow: log (or convert) data to an `.rrd`, start a catalog server (or connect to an existing one if using the commercial Rerun Hub), register the `.rrd` as a segment, then visualize and query across recordings.
|
|
|
|
### Log
|
|
|
|
Save data to an `.rrd` see [Log and Ingest](./getting-started/data-in.md) for more details.
|
|
If you already have data in another format see our [how-to](https://rerun.io/docs/howto/logging-and-ingestion) for various examples converting to `.rrd`.
|
|
|
|
snippet: tutorials/getting_started_log
|
|
### Start a catalog server
|
|
|
|
`rerun server` starts a local catalog on port `51234` (use Rerun Hub for persistent, multi-user storage), then connect from your code:
|
|
|
|
```bash
|
|
rerun server
|
|
```
|
|
|
|
snippet: tutorials/getting_started[setup]
|
|
|
|
### Ingest
|
|
|
|
Register an `.rrd` with a dataset so it shows up as a queryable segment.
|
|
|
|
snippet: tutorials/getting_started[ingest]
|
|
|
|
### Visualize
|
|
|
|
Point the Viewer at your server to browse every recording in the catalog.
|
|
See [Configure the Viewer](./getting-started/configure-the-viewer.md).
|
|
|
|
```bash
|
|
rerun rerun+http://127.0.0.1:51234
|
|
```
|
|
|
|
### Query
|
|
|
|
Query the catalog into a [DataFusion](https://datafusion.apache.org/) DataFrame. See [Query and Transform](./getting-started/data-out.md).
|
|
|
|
snippet: tutorials/getting_started[query]
|
|
|
|
### Train
|
|
|
|
Connect a Dataloader to the server to generate training batches. See [Train](./getting-started/train.md).
|
|
|
|
snippet: tutorials/getting_started[train]
|
|
|
|
## If you're stuck
|
|
|
|
- Check the [troubleshooting guide](./getting-started/install-rerun/troubleshooting.md).
|
|
- [Open an issue](https://github.com/rerun-io/rerun/issues/new/choose).
|
|
- [Join the Discord server](https://discord.gg/PXtCgFBSmH).
|