Skip to content

Commit fbab241

Browse files
fix: prepare architecture.yaml for jazzy (#364)
* Prepare architecture.yaml for jazzy * ci(pre-commit): autofix * modify configuration section --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 7deb70c commit fbab241

File tree

2 files changed

+62
-14
lines changed

2 files changed

+62
-14
lines changed

docs/tutorials/configuration.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,26 @@
22

33
Please download [the architecture file](https://raw.githubusercontent.com/tier4/caret_demos/main/samples/end_to_end_sample/architecture.yaml) and use it for visualization.
44

5-
```bash
6-
cd ~/ros2_ws/evaluate
7-
wget https://raw.githubusercontent.com/tier4/caret_demos/main/samples/end_to_end_sample/architecture.yaml
8-
```
5+
=== "humble"
6+
7+
``` bash
8+
cd ~/ros2_ws/evaluate
9+
wget https://raw.githubusercontent.com/tier4/caret_demos/main/samples/end_to_end_sample/architecture.yaml
10+
```
11+
12+
=== "iron"
13+
14+
``` bash
15+
cd ~/ros2_ws/evaluate
16+
wget https://raw.githubusercontent.com/tier4/caret_demos/main/samples/end_to_end_sample/architecture.yaml
17+
```
18+
19+
=== "jazzy"
20+
21+
``` bash
22+
cd ~/ros2_ws/evaluate
23+
wget https://raw.githubusercontent.com/tier4/caret_demos/main/samples/end_to_end_sample/architecture_jazzy.yaml
24+
```
925

1026
Configuration is an advanced topic for beginners. This section only provides the architecture file for [the next section of visualization](./visualization.md).
1127

docs/tutorials/visualization.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,52 @@ This section will show basic flow to visualize data with Jupyter notebook.
2727

2828
Locate trace data on Jupyter notebook as well as the architecture file.
2929

30-
```python
31-
from caret_analyze import Architecture, Application, Lttng
30+
=== "humble"
3231

33-
# load the architecture file which is created in the previous page
34-
arch = Architecture('yaml', './architecture.yaml')
32+
``` python
33+
from caret_analyze import Architecture, Application, Lttng
3534

36-
# load recorded data by CARET
37-
lttng = Lttng('./e2e_sample')
35+
# load the architecture file which is created in the previous page
36+
arch = Architecture('yaml', './architecture.yaml')
3837

39-
# map the application architecture to recorded data
40-
app = Application(arch, lttng)
41-
```
38+
# load recorded data by CARET
39+
lttng = Lttng('./e2e_sample')
40+
41+
# map the application architecture to recorded data
42+
app = Application(arch, lttng)
43+
```
44+
45+
=== "iron"
46+
47+
``` python
48+
from caret_analyze import Architecture, Application, Lttng
49+
50+
# load the architecture file which is created in the previous page
51+
arch = Architecture('yaml', './architecture.yaml')
52+
53+
# load recorded data by CARET
54+
lttng = Lttng('./e2e_sample')
55+
56+
# map the application architecture to recorded data
57+
app = Application(arch, lttng)
58+
```
59+
60+
=== "jazzy"
61+
62+
``` python
63+
from caret_analyze import Architecture, Application, Lttng
64+
65+
# load the architecture file which is created in the previous page
66+
arch = Architecture('yaml', './architecture_jazzy.yaml')
67+
68+
# load recorded data by CARET
69+
lttng = Lttng('./e2e_sample')
70+
71+
# map the application architecture to recorded data
72+
app = Application(arch, lttng)
73+
```
4274

43-
After execution of the code, users will often refer to the `app` object defined as `Application` class. The `app` objects provides users latency of callbacks, communication, and paths. `Application` class is similar to `Architecture` class which describes structure of the application and their interfaces are similar. In addition, `Application` class has interfaces to get latency.
75+
After execution of the code, users will often refer to the `app` object defined as `Application` class. The `app` objects provides users latency of callbacks, communication, and paths. `Application` class is similar to `Architecture` class which describes structure of the application and their interfaces are similar. In addition, `Application` class has interfaces to get latency.
4476

4577
## Basic API to get latency
4678

0 commit comments

Comments
 (0)