Project

General

Profile

Running CAMS in simulation mode (Tutorial) » History » Version 13

Rafael Bailon-Ruiz, 2020-10-08 15:07

1 3 Rafael Bailon-Ruiz
h1. Running CAMS (Tutorial)
2
3
This tutorial will teach you how to run the CAMS GUI with a simple scenario in simulation mode.
4
5
{{toc}}
6
7
First of all, *make sure you successfully completed the [[Installation#Developer installation process|Installation (Developer)]] tutorial*. Then, open a terminal and change the current directory to the folder where the core packages are installed.
8
9 6 Rafael Bailon-Ruiz
<pre><code class="shell">
10
cd /path/to/nephelae_workspace
11
</code></pre>
12
13 10 Rafael Bailon-Ruiz
h2. Access the simulated cloud environment files
14 3 Rafael Bailon-Ruiz
15 7 Rafael Bailon-Ruiz
In order to run CAMS in fully simulated mode first yout need a mesoNH file describing a synthetic atmospheric environment. MesoNH files are databases in "NetCDF _(.nc)_ format":https://en.wikipedia.org/wiki/NetCDF.
16 3 Rafael Bailon-Ruiz
17 5 Rafael Bailon-Ruiz
The computer @girofle@ at LAAS contains a mesoNH file that can be used with CAMS. You can use the command below to mount the folder the remote folder as a local directory:
18 3 Rafael Bailon-Ruiz
19
<pre><code class="shell">
20
sshfs girofle.laas.fr:/media/Nephelae-Data/data/Nephelae/ mesonh_girofle_mount/
21
</code></pre>
22
23 7 Rafael Bailon-Ruiz
The recommended file for this tutorial is:
24 1 Rafael Bailon-Ruiz
25 7 Rafael Bailon-Ruiz
<pre>
26
REFHR.1.ARMCu.4D.nc
27
</pre>
28 3 Rafael Bailon-Ruiz
29 7 Rafael Bailon-Ruiz
Despite its huge size (~72 GB), the best way to work with this particular file is to download it to your computer. If you are at LAAS connected with an Ethernet cable, you have a high-bandwith and low-lattency link. Therefore you can read the files in the remote folder directly, but beware of errors that can occur if the quality of the connection degrades.
30 1 Rafael Bailon-Ruiz
31 3 Rafael Bailon-Ruiz
32 1 Rafael Bailon-Ruiz
h2. Scenario setup
33
34 9 Rafael Bailon-Ruiz
A valid configuration file is required to run the graphical interface server. Scenario configuration files describe the atmospheric environment and the UAVs so CAMS can use the appropriate algorithms and models to manage them. For this tutorial a simple configuration file is provided describing a scenario built upon a simulated atmosphere with cumulus clouds and two UAVs. 
35 3 Rafael Bailon-Ruiz
36 10 Rafael Bailon-Ruiz
1. Download the configuration file for this tutorial: attachment:tutorial_simulation_mesonh_2uav.yaml
37 3 Rafael Bailon-Ruiz
38 10 Rafael Bailon-Ruiz
2. You need adapt the following configuration values to match with the path of your CAMS workspace. Replace @/PATH/TO/@ with the actual path.
39 1 Rafael Bailon-Ruiz
40
41
<pre>
42 10 Rafael Bailon-Ruiz
database: filepath: '/PATH/TO/database01.neph'  # CAMS database file. It stores the atmospheric and UAV information generated during the run
43
mesonh_files:  &mesonh_files '/PATH/TO/REFHR.1.ARMCu.4D.nc' # MesoNH simulation file.
44
aircrafts: 200: plugins: Missions: backup_file: '/PATH/TO/backup_200.bin' #
45
aircrafts: 201: plugins: Missions: backup_file: '/PATH/TO/backup_201.bin' #
46 8 Rafael Bailon-Ruiz
</pre>
47
48 10 Rafael Bailon-Ruiz
There are many other options that can be set in this configuration file to adapt CAMS to your needs. For more information, there is a [[scenario configuration reference guide]] in the wiki but for now should stay with the default setup.
49 8 Rafael Bailon-Ruiz
50 10 Rafael Bailon-Ruiz
TODO: Introduce & explain the main parameter groups in the configuration file to give an overview of the situation the user will be managing.
51 8 Rafael Bailon-Ruiz
52
53 10 Rafael Bailon-Ruiz
h2. Launch the UAV simulation with paparazzi
54 8 Rafael Bailon-Ruiz
55 11 Rafael Bailon-Ruiz
h3. Configure the UAVs
56
57 10 Rafael Bailon-Ruiz
Open a new terminal, change the current directory to the paparazzi installation folder and open the _Paparazzi center_ :
58 8 Rafael Bailon-Ruiz
59 10 Rafael Bailon-Ruiz
<pre><code class="shell">
60
cd /PATH/TO/paparazzi
61
./paparazzi
62 8 Rafael Bailon-Ruiz
</code></pre>
63 1 Rafael Bailon-Ruiz
64 11 Rafael Bailon-Ruiz
1. Select the aircraft *Lisa_Neph_0* from the A/C list
65
66 1 Rafael Bailon-Ruiz
2. Click build
67
68 11 Rafael Bailon-Ruiz
3. Repeat the same procedure with the *Lisa_Neph_1* aircraft
69
70 13 Rafael Bailon-Ruiz
{{thumbnail(paparazzi_center_instructions.png, size=500, title=Paparazzi center)}}
71 11 Rafael Bailon-Ruiz
72
*You only need to do this operation once, unless you modify the UAVs or change computers!*
73
74
h3. Start the simulation
75
76
Open two new terminal windows and run respectively to start the simulation of both UAVs:
77
78
<pre><code class="shell">
79
cd nephelae_paparazzi/tests/sim_launchers && python3 sim_launcher.py Lisa_Neph_0
80
</code></pre>
81
82
<pre><code class="shell">
83
cd nephelae_paparazzi/tests/sim_launchers && python3 sim_launcher.py Lisa_Neph_1
84
</code></pre>
85
86
Four new windows will appear _(You can close the duplicated GCS)_
87
88
| !server_lisa_neph_0.png! | !server_lisa_neph_1.png! | 
89 1 Rafael Bailon-Ruiz
90 13 Rafael Bailon-Ruiz
{{thumbnail(paparazzi_gcs_2_UAV_simulation_tutorial.png, size=500, title=Paparazzi GCS)}}
91 1 Rafael Bailon-Ruiz
92
Wait a couple of seconds for the simulation to warm up and then click on the *launch button* !gcs_launch_button.png! on *Lisa_Neph_0* and *Lisa_Neph_1*
93 13 Rafael Bailon-Ruiz
94
h2. Run the CAMS GUI
95
96
Go to the installation folder of nephelae_gui and in a terminal, run:
97
98
<pre><code class="shell">
99
export NEPHELAE_CONFIG="/PATH/TO/tutorial_simulation_mesonh_2uav.yaml"
100
make runserver
101
</code></pre>
102
103
Replacing @/PATH/TO/@ with the actual path.
104
105
h2. Create a mission for a UAV
106
107
TODO: