Skip to content

Commit c5d54b0

Browse files
committed
feat: update Japanese documentation for clustering module and add new tutorial sections
1 parent 6425484 commit c5d54b0

File tree

10 files changed

+127
-81
lines changed

10 files changed

+127
-81
lines changed

docs/source/hands-on/clustering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
## クラスタリングモジュールの実装
2121

22-
:::{note}
22+
```{note}
2323
以降の作業では、カレントディレクトリがプロジェクトのルートディレクトリであることを前提としています。
24-
:::
24+
```
2525

2626
まず、クラスタリングモジュールを記述するためのファイルを作成します。
2727

docs/source/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,11 @@ ADF Core Python を始めるには、インストール手順に従い、この
3535
:maxdepth: 1
3636
:caption: チュートリアル:
3737

38-
installation/installation
39-
usage/agent/agent
40-
usage/config/config
41-
usage/module/module
38+
tutorial/environment/environment
39+
tutorial/install/install
40+
tutorial/agent/agent
41+
tutorial/config/config
42+
tutorial/module/module
4243

4344
.. toctree::
4445
:maxdepth: 1

docs/source/introduction/introduction.rst

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# エージェントの作成
2+
3+
このセクションでは、`adf-core-python` ライブラリの使用方法の概要を提供します。
4+
5+
## 新規エージェントの作成
6+
7+
新規エージェントを作成するには、次のコマンドを実行します:
8+
9+
```bash
10+
adf-core-python
11+
```
12+
13+
実行すると、下記のような対話形式のプロンプトが表示されます:
14+
15+
```bash
16+
Your agent team name: my-agent
17+
Creating a new agent team with name: my-agent
18+
```
19+
20+
入力後、下記のようなエージェントのテンプレートがカレントディレクトリに作成されます。
21+
22+
```bash
23+
.
24+
└── my-agent
25+
├── config
26+
│ ├── development.json
27+
│ ├── launcher.yaml
28+
│ └── module.yaml
29+
├── main.py
30+
└── src
31+
└── my-agent
32+
├── __init__.py
33+
└── module
34+
├── __init__.py
35+
└── complex
36+
├── __init__.py
37+
├── sample_human_detector.py
38+
├── sample_road_detector.py
39+
└── sample_search.py
40+
```
41+
42+
## シミュレーションを実行する
43+
44+
シミュレーションサーバーを以下のコマンドで起動します:
45+
46+
```bash
47+
cd WORKING_DIR/rcrs-server/scripts
48+
./start-comprun.sh -m ../maps/test/map -c ../maps/test/config
49+
```
50+
51+
その後、エージェントを起動します:
52+
53+
```bash
54+
cd WORKING_DIR/my-agent
55+
python main.py
56+
```
57+
58+
エージェントが正常に起動すると、シミュレーションサーバーに接続され、エージェントがシミュレーションに参加し、エージェントが動き出します。
59+
途中で止めたい場合は、それぞれのコマンドラインで `Ctrl + C` を押してください。
60+
61+
```{warning}
62+
シミュレーションサーバーを停止させたあとは、プロセスが残ってしまう場合があるので`./kill.sh` を実行してください。
63+
```
File renamed without changes.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# 環境構築
2+
3+
## 必要なもの
4+
5+
- Git
6+
- Python 3.12 以上
7+
- OpenJDK 17
8+
9+
[Windowsでの必要なもののインストール方法](./windows/install.md)
10+
11+
## シミュレーションサーバーのインストール
12+
13+
```{note}
14+
WORKING_DIR は任意のディレクトリを指定してください。
15+
```
16+
17+
```bash
18+
cd WORKING_DIR
19+
git clone https://github.com/roborescue/rcrs-server.git
20+
cd rcrs-server
21+
./gradlew completeBuild
22+
```
23+
ビルドした際に以下のようなメッセージが表示されたら成功です。
24+
25+
```bash
26+
BUILD SUCCESSFUL in ...
27+
```
28+
29+
## シュミレーションサーバーの動作確認
30+
31+
```bash
32+
cd WORKING_DIR/rcrs-server/scripts
33+
./start-comprun.sh -m ../maps/test/map -c ../maps/test/config
34+
```
35+
36+
何個かのウィンドウが表示されたら成功です。
37+
コマンドラインで `Ctrl + C` を押すとシミュレーションサーバーが終了します。
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Windowsでの環境構築
2+
3+
## 1. Gitのインストール
4+
5+
1. [Git for Windows](https://gitforwindows.org/)の公式サイトにアクセスします。
6+
2. ダウンロードページから最新のバージョンをダウンロードします。
7+
3. ダウンロードしたファイルを開き、インストールを開始します。
8+
9+
## 2. Pythonのインストール
10+
11+
1. [Python](https://www.python.org/downloads/)の公式サイトにアクセスします。
12+
2. ダウンロードページから最新のバージョンをダウンロードします。
13+
3. ダウンロードしたファイルを開き、インストールを開始します。
14+
4. インストール時に「Add python.exe to PATH」にチェックを入れてください。
15+
16+
## 3. OpenJDKのインストール
17+
18+
1. [OpenJDK](https://jdk.java.net/archive/)の公式サイトにアクセスします。
19+
2. ダウンロードページから17.0.2のバージョンをダウンロードします。
20+
3. ダウンロードしたファイルを開き、インストールを開始します。
File renamed without changes.

docs/source/usage/agent/agent.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)