Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@TakanoTaiga
TakanoTaiga committed Nov 12, 2023
1 parent 3f4ff08 commit b194090
Show file tree
Hide file tree
Showing 7 changed files with 332 additions and 343 deletions.
163 changes: 77 additions & 86 deletions docs/Components/ROS2/ROS2ForUnity/index.md
View file

Large diffs are not rendered by default.

174 changes: 82 additions & 92 deletions docs/Components/Sensors/CameraSensor/index.md
View file

Large diffs are not rendered by default.

66 changes: 35 additions & 31 deletions docs/DeveloperGuide/Documentation/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,43 +1,47 @@
# Documentation
This document uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
# ドキュメンテーション
この文書は [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) を使用しています。

## Local hosting
## ローカルホスティング

1 Install Material for `MkDocs`.
```
python3 -m pip install mkdocs-material
```
2 Hosting on localhost.
```
$ cd CoRE.SIM
$ python3 -m mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.16 seconds
INFO - [03:13:22] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [03:13:22] Serving on http://127.0.0.1:8000/
```
1. `MkDocs` 用の Material をインストールします。
```
python3 -m pip install mkdocs-material
```

2. ローカルホスティングを開始します。
```
$ cd CoRE.SIM
$ python3 -m mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.16 seconds
INFO - [03:13:22] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [03:13:22] Serving on http://127.0.0.1:8000/
```

3 Access `http://127.0.0.1:8000/` with a web browser.
<!-- (TODO change image) -->
![](image_0.png)
3. ウェブブラウザで `http://127.0.0.1:8000/` にアクセスします。
<!-- (TODO 画像を変更) -->
![](image_0.png)

For further reference see [Material for MkDocs - Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/).
詳細は [Material for MkDocs - 入門](https://squidfunk.github.io/mkdocs-material/getting-started/) を参照してください。

## MkDocs ファイル
新しいドキュメンテーションファイルには、次の `/docs` ディレクトリと `mkdocs.yml` を使用します。

## MkDocs files
Use the following `/docs` directory and `mkdocs.yml` for new documentation files.
```
CoRE.SIM
├─ docs/ // markdown and image file for each document.
└─ mkdocs.yml // mkdocs config.
├─ docs/ // 各ドキュメントのマークダウンと画像ファイル
└─ mkdocs.yml // MkDocs の設定
```
Create one directory per document. For example, the directory structure of this "Documentation" page might look like this.

各ドキュメントごとにディレクトリを作成します。例えば、この "Documentation" ページのディレクトリ構造は次のようになるかもしれません。

```
CoRE.SIM
└─ docs/ // Root of all documents
└─ DeveloperGuide // Category
└─ Documentation // Root of each document
├─ index.md // Markdown file
└─ image_0.png // Images used in markdown file
└─ docs/ // すべてのドキュメントのルート
└─ DeveloperGuide // カテゴリ
└─ Documentation // 各ドキュメントのルート
├─ index.md // マークダウンファイル
└─ image_0.png // マークダウンファイルで使用される画像
```
12 changes: 6 additions & 6 deletions docs/DeveloperGuide/License/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# AWSIM Licenses
# CoRE.SIMおよびAWSIMライセンス

*AWSIM License* applies to [tier4/AWSIM repositories](https://github.com/tier4/AWSIM) and all content contained in the [Releases](https://github.com/tier4/AWSIM/releases).
*CoRE.SIMおよびAWSIMライセンス*は[tier4/AWSIMリポジトリ](https://github.com/tier4/AWSIM)および[Releases](https://github.com/tier4/AWSIM/releases)に含まれるすべてのコンテンツに適用されます。

- *AWSIM* specific code is distributed under *Apache2.0 License*.
The following extensions are included (`*.cs` `*.compute` `*.xml`)
- *AWSIM* specific assets are distributed under *CC BY-NC License*.
The following extensions are included (`*.fbx` `*.pcd` `*.osm` `*.png` `*.anim` `*.unitypackage` `*.x86_64`)
- *CoRE.SIMおよびAWSIM*固有のコードは*Apache2.0ライセンス*の下で配布されています。
次の拡張子が含まれています（`*.cs` `*.compute` `*.xml`）
- *CoRE.SIMおよびAWSIM*固有のアセットは*CC BY-NCライセンス*の下で配布されています。
次の拡張子が含まれています（`*.fbx` `*.pcd` `*.osm` `*.png` `*.anim` `*.unitypackage` `*.x86_64`)

##### Apache2.0 License
```
Expand Down
171 changes: 86 additions & 85 deletions docs/GettingStarted/QuickStartDemo/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,107 +1,108 @@
# Quick Start Demo
# クイックスタートデモ

Below you can find instructions on how to setup the self-driving demo of CoRE.SIM simulation controlled by Autoware.
The instruction assumes using the Ubuntu OS.
!!! info

### PC specs
現在、[Unityプロジェクトのセットアップ](../SetupUnityProject)のチュートリアルが推奨されています。

Please make sure that your machine meets the following requirements in order to run the simulation correctly:
以下に、CoRE.SIMシミュレーションのセットアップ手順があります。この手順はUbuntu OSを使用することを前提としています。

|Required PC Specs||
### PCの仕様

シミュレーションを正しく実行するために、コンピュータが以下の要件を満たしていることを確認してください：

|必要なPC仕様||
|:--|:--|
|OS|Ubuntu 22.04|
|CPU|4cores and 8thread or higher|
|GPU|GTX 1070 or higher|
|NVIDIA Driver (Ubuntu 22)|>=515.43.04|
|CPU|4コアと8スレッド以上|
|GPU|GTX 1070以上|
|NVIDIAドライバー（Ubuntu 22）|>=515.43.04|


### Localhost settings
### ローカルホストの設定

The simulation is based on the appropriate network setting, which allows for trouble-free communication of the CoRE.SIM simulation with the Autoware software.
To apply required localhost settings please add the following lines to `~/.bashrc` & `~/.profile` files.
シミュレーションは、CoRE.SIMシミュレーションとROS 2ソフトウェアのトラブルフリーな通信を可能にする適切なネットワーク設定に基づいています。
必要なローカルホスト設定を適用するには、次の行を`~/.bashrc`および`~/.profile`ファイルに追加してください。

``` bash
```bash
source /opt/ros/humble/setup.bash
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
```

## Start the demo

### Running the CoRE.SIM simulation demo

To run the simulator, please follow the steps below.

1. Install Nvidia GPU driver (Skip if already installed).
1. Install the recommended version of the driver.
```
sudo apt update
sudo ubuntu-drivers autoinstall
```
2. Reboot your machine to make the installed driver detected by the system.
```
sudo reboot
```
3. Open terminal and check if `nvidia-smi` command is available and outputs summary similar to the one presented below.
```
$ nvidia-smi
Fri Oct 14 01:41:05 2022
+-----------------------------------------------------------------------------+
| NVIDIA-SMI 515.65.01 Driver Version: 515.65.01 CUDA Version: 11.7 |
|-------------------------------+----------------------+----------------------+
| GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC |
| Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. |
| | | MIG M. |
|===============================+======================+======================|
| 0 NVIDIA GeForce ... Off | 00000000:01:00.0 On | N/A |
| 37% 31C P8 30W / 250W | 188MiB / 11264MiB | 3% Default |
| | | N/A |
+-------------------------------+----------------------+----------------------+
+-----------------------------------------------------------------------------+
| Processes: |
| GPU GI CI PID Type Process name GPU Memory |
| ID ID Usage |
|=============================================================================|
| 0 N/A N/A 1151 G /usr/lib/xorg/Xorg 133MiB |
| 0 N/A N/A 1470 G /usr/bin/gnome-shell 45MiB |
+-----------------------------------------------------------------------------+
```
2. Install Vulkan Graphics Library (Skip if already installed).
1. Update the environment.
```
sudo apt update
```
2. Install the library.
```
sudo apt install libvulkan1
```
3. Download and Run CoRE.SIM Demo binary.
1. Download `CoRE.SIM.zip`.
[Download CoRE.SIM Demo for ubuntu](https://github.com/StrayedCats/CoRE.SIM/releases){.md-button .md-button--primary}
## デモの開始

### CoRE.SIMシミュレーションデモの実行

シミュレータを実行するには、以下の手順に従ってください。

1. NVIDIA GPUドライバーをインストールします（すでにインストールされている場合はスキップ）。
1. 推奨されるバージョンのドライバーをインストールします。
```
sudo apt update
sudo ubuntu-drivers autoinstall
```
2. インストールされたドライバーがシステムに検出されるように、マシンを再起動します。
```
sudo reboot
```
3. ターミナルを開いて、`nvidia-smi`コマンドが利用可能で、以下に示すような要約を出力するか確認します。
```
$ nvidia-smi
Fri Oct 14 01:41:05 2022
+-----------------------------------------------------------------------------+
| NVIDIA-SMI 515.65.01 Driver Version: 515.65.01 CUDA Version: 11.7 |
|-------------------------------+----------------------+----------------------+
| GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC |
| Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. |
| | | MIG M. |
|===============================+======================+======================|
| 0 NVIDIA GeForce ... Off | 00000000:01:00.0 On | N/A |
| 37% 31C P8 30W / 250W | 188MiB / 11264MiB | 3% Default |
| | | N/A |
+-------------------------------+----------------------+----------------------+
+-----------------------------------------------------------------------------+
| Processes: |
| GPU GI CI PID Type Process name GPU Memory |
| ID ID Usage |
|=============================================================================|
| 0 N/A N/A 1151 G /usr/lib/xorg/Xorg 133MiB |
| 0 N/A N/A 1470 G /usr/bin/gnome-shell 45MiB |
+-----------------------------------------------------------------------------+
```

2. Vulkan Graphics Libraryをインストールします（すでにインストールされている場合はスキップ）。
1. 環境を更新します。
```
sudo apt update
```
2. ライブラリをインストールします。
```
sudo apt install libvulkan1
```

3. CoRE.SIMデモバイナリをダウンロードして実行します。

1. `CoRE.SIM.zip`をダウンロードします。

[Ubuntu用のCoRE.SIMデモをダウンロード](https://github.com/StrayedCats/CoRE.SIM/releases){.md-button .md-button--primary}

2. Unzip the downloaded file.
3. Make the `CoRE.Sim.x86_64` file executable.
2. ダウンロードしたファイルを解凍します。

Rightclick the `CoRE.SIM.x86_64` file and check the `Execute` checkbox
3. `CoRE.SIM.x86_64`ファイルに実行権限を付与します。

![](Image_1.png)
`CoRE.SIM.x86_64`ファイルを右クリックし、`実行`のチェックボックスをオンにします

or execute the command below.
または、以下のコマンドを実行します。

```
chmod +x <path to CoRE.SIM folder>/CoRE.SIM.x86_64
```
```
chmod +x <CoRE.SIMフォルダへのパス>/CoRE.SIM.x86_64
```
4. Launch `CoRE.SIM.x86_64`.
```
./<path to CoRE.SIM folder>/CoRE.SIM.x86_64
```
4. `CoRE.SIM.x86_64`を起動します。
```
./<CoRE.SIMフォルダへのパス>/CoRE.SIM.x86_64
```
!!! warning
!!! 注意
It may take some time for the application to start the so please wait until image similar to the one presented below is visible in your application window.
アプリケーションが起動するまでに時間がかかる場合があるので、アプリケーションウィンドウに以下に似た画像が表示されるまでお待ちください。
Loading

0 comments on commit b194090

Please sign in to comment.