rerun/examples/manifest.yml at main · lundstrom14/rerun · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# `landing` expects this file to have the following format:
# root {
#   prelude: string
#   children: [
#     {
#       # the path in the url, e.g. to get `rerun.io/examples/minimal` set `name: "minimal"`
#       name: string
#       # path to the python example
#       python: string?
#       # path to the rust example
#       rust: string?
#       # at least one of `python` or `rust` should be set
#     }
#     OR
#     {
#       # the path in the url, e.g. `rerun.io/examples/artificial-data`
#       name: string
#       # the title in the side nav + header, e.g. `Examples with Artificial Data`
#       title: string
#       # the content that's placed right after the header.
#       # used to include setup instructions and general info
#       prelude: string
#       children: [
#         { # same as above
#           name: string
#           python: string?
#           rust: string?
#         }
#       ]
#     }
#   ]
# }

root:
  prelude: |
    In the Rerun [GitHub](https://github.com/rerun-io/rerun) repository we maintain
    a list of examples that demonstrate using the Rerun logging APIs. Generally the
    examples are individually self-contained, and can be run directly from a Git
    clone of the repository. Many of the Python examples need additional dependencies
    set up in a `requirements.txt` next to the example. These are noted in the
    individual example sections below.
  children:
    - name: real-data
      title: Examples with real data
      prelude: |
        The following examples illustrate using the Rerun logging SDK with potential real-world (if toy) use cases.
        They all require additional data to be downloaded, so an internet connection is needed at least once.
        Each example downloads it's own data, so no additional steps are needed.
        For the simplest possible examples showing how to use each api,
        check out [Loggable Data Types](/docs/reference/data_types).
      children:
        - name: arkit_scenes
          python: python/arkit_scenes

        - name: structure-from-motion
          python: python/structure_from_motion

        - name: signed-distance-fields
          python: python/signed_distance_fields

        - name: dicom-mri
          python: python/dicom_mri

        - name: human-pose-tracking
          python: python/human_pose_tracking

        - name: live-camera-edge-detection
          python: python/live_camera_edge_detection

        - name: live-depth-sensor
          python: python/live_depth_sensor

        - name: rgbd
          python: python/rgbd

        - name: objectron
          python: python/objectron
          rust: rust/objectron

        - name: ros-node
          python: python/ros_node

        - name: raw-mesh
          python: python/raw_mesh
          rust: rust/raw_mesh

        - name: segment-anything-model
          python: python/segment_anything_model

        - name: depth-guided-stable-diffusion
          python: python/depth_guided_stable_diffusion

        - name: detect-and-track-objects
          python: python/detect_and_track_objects

        - name: face-tracking
          python: python/face_tracking

    - name: artificial-data
      title: Examples with artificial data
      prelude: |
        The following examples serve to illustrate various uses of the Rerun logging SDK.
        They should not require any additional data downloads, and should run offline.
        For the simplest possible examples showing how to use each api,
        check out [Loggable Data Types](/docs/reference/data_types).
      children:
        - name: minimal
          python: python/minimal
          rust: rust/minimal

        - name: car
          python: python/car

        - name: clock
          python: python/clock
          rust: rust/clock

        - name: multiprocessing
          python: python/multiprocessing

        - name: multithreading
          python: python/multithreading

        - name: plots
          python: python/plots

        - name: text-logging
          python: python/text_logging

    - name: setup
      title: Setup
      prelude: |
        Make sure you have the Rerun repository checked out and the latest SDK installed.

        ```bash
        pip install --upgrade rerun-sdk  # install the latest Rerun SDK
        git clone git@github.com:rerun-io/rerun.git  # Clone the repository
        cd rerun
        git checkout latest  # Check out the commit matching the latest SDK release
        ```
        > Note: Make sure your SDK version matches the examples.
        For example, if your SDK version is `0.3.1`, check out the matching tag
        in the Rerun repository by running `git checkout v0.3.1`.