|
|
|
|
|
# Table of Contents
|
|
|
|
|
|
1. [Foreword](#org9bef77f)
|
|
|
2. [Glossary](#org7461143)
|
|
|
3. [Preliminary notes](#org8dd3044)
|
|
|
4. [The steps to run CUSCUS](#org90b6f77)
|
|
|
1. [First Step - Set up a virtual machine with Ubuntu 14.04.3 (or do it with a real machine)](#orga0f98d3)
|
|
|
2. [Second Step - Install NS-3 (following the NS-3 site instructions)](#org63b7631)
|
|
|
3. [Third Step - Install FL-AIR (following the FL-AIR site instructions)](#orgf56de82)
|
|
|
1. [Extra - Make sure that](#orgc73873b)
|
|
|
4. [Fourth Step](#org24d56b4)
|
|
|
1. [Foreword](#orgbd342c8)
|
|
|
2. [Glossary](#org9b9da7d)
|
|
|
3. [Preliminary notes](#orgea0f893)
|
|
|
4. [The steps to run CUSCUS](#orgdcbdbfe)
|
|
|
1. [Step zero - Gitpull the project somewhere](#org14dbf11)
|
|
|
2. [First Step - Set up a virtual machine with Ubuntu 14.04.3 (or do it with a real machine)](#orgca9cd55)
|
|
|
3. [Second Step - Install NS-3 (following the NS-3 site instructions)](#org9d8def7)
|
|
|
4. [Third Step - Install FL-AIR (following the FL-AIR site instructions)](#org0893e25)
|
|
|
1. [Extra - Make sure that](#org1f95cf9)
|
|
|
5. [Fourth Step](#orgc4088bf)
|
|
|
|
|
|
|
|
|
|
|
|
<a id="org9bef77f"></a>
|
|
|
<a id="orgbd342c8"></a>
|
|
|
|
|
|
# Foreword
|
|
|
|
... | ... | @@ -24,15 +25,16 @@ are our *experiences*. |
|
|
If you find a workaround, some new insights, etc…please let us know.
|
|
|
|
|
|
|
|
|
<a id="org7461143"></a>
|
|
|
<a id="org9b9da7d"></a>
|
|
|
|
|
|
# Glossary
|
|
|
|
|
|
- **FLAIR:** Framework Libre Air (The Control Part)
|
|
|
- **NS3:** The Network Simulator 3 (The Network Part)
|
|
|
- **$CUSCUS:** the place where you gitpulled *CUSCUS*
|
|
|
|
|
|
|
|
|
<a id="org8dd3044"></a>
|
|
|
<a id="orgea0f893"></a>
|
|
|
|
|
|
# Preliminary notes
|
|
|
|
... | ... | @@ -43,23 +45,30 @@ If you find a workaround, some new insights, etc…please let us know. |
|
|
**USE** `/bin/bash`. Other shells do not work for the FLAIR framework. Save the hassle and use bash temporarely.
|
|
|
|
|
|
|
|
|
<a id="org90b6f77"></a>
|
|
|
<a id="orgdcbdbfe"></a>
|
|
|
|
|
|
# The steps to run CUSCUS
|
|
|
|
|
|
|
|
|
<a id="orga0f98d3"></a>
|
|
|
<a id="org14dbf11"></a>
|
|
|
|
|
|
## Step zero - Gitpull the project somewhere
|
|
|
|
|
|
- `git pull https://gitlab.utc.fr/zemanico/CUSCUS.git`
|
|
|
|
|
|
|
|
|
<a id="orgca9cd55"></a>
|
|
|
|
|
|
## First Step - Set up a virtual machine with Ubuntu 14.04.3 (or do it with a real machine)
|
|
|
|
|
|
a kind suggestion: use [Vagrant](https://www.vagrantup.com/) to easily set up your VMs.
|
|
|
A kind suggestion: use [Vagrant](https://www.vagrantup.com/) to easily set up your VMs.
|
|
|
|
|
|
We used this [box](https://app.vagrantup.com/ubuntu/boxes/trusty64).
|
|
|
|
|
|
It takes up a lot of space, please reserve at least `30GB`.
|
|
|
|
|
|
|
|
|
<a id="org63b7631"></a>
|
|
|
<a id="org9d8def7"></a>
|
|
|
|
|
|
## Second Step - Install [NS-3](https://www.nsnam.org) (following the NS-3 site instructions)
|
|
|
|
... | ... | @@ -80,30 +89,29 @@ is enough to get NS3 up and running. |
|
|
the Flair toolchain (that I cannot easily modify)
|
|
|
|
|
|
4. Install NS-3 as per [tutorial](https://www.nsnam.org/docs/tutorial/html/getting-started.html).
|
|
|
- Configure NS-3 with waf: –enable-sudo –enable-tests –enable-examples
|
|
|
- Configure NS-3 with waf: `--enable-sudo --enable-tests --enable-examples`
|
|
|
- To save time, do it *before* running waf in the tutorial.
|
|
|
|
|
|
- Save your ns3 main path as $NS3<sub>MAIN</sub><sub>PATH</sub>
|
|
|
- Save your ns3 main path as `$NS3_MAIN_PATH`
|
|
|
- echo `export <place where waf is located> NS3_MAIN_PATH` in your `.bashrc`
|
|
|
|
|
|
5. Install the NS3 CUSCUS mod:
|
|
|
- Copy the files CUSCUS/mods/ns3-src/src/mobility/model/uav-link-mobility-model.cc & .h into the directory $NS3<sub>MAIN</sub><sub>PATH</sub>/src/mobility/model/
|
|
|
- Modify the text file &NS3<sub>MAIN</sub><sub>PATH</sub>/src/mobility/wscript in order to include the new files.
|
|
|
- In CUSCUS/mods/ns3-src/src/mobility/wscript there is an example;
|
|
|
- Copy the files `$CUSCUS/mods/ns3-src/src/mobility/model/uav-link-mobility-model.cc & .h` into the directory `$NS3_MAIN_PATH/src/mobility/model/`
|
|
|
- Modify the text file `$NS3_MAIN_PATH/src/mobility/wscript` in order to include the new files.
|
|
|
- In `$CUSCUS/mods/ns3-src/src/mobility/wscript` there is an example;
|
|
|
- it can be different from the actual file that you have depending on the models present on ns-3.
|
|
|
|
|
|
- Basically you have to add in "wscript" in the section "mobility.source" and "headers.source" the two source files.
|
|
|
- Copy the files CUSCUS/mods/ns3-src/src/buildings/model/hybrid-raylight-buildings-propagation-loss-model.cc & .h into the directory $NS3<sub>MAIN</sub><sub>PATH</sub>/src/buildings/model/
|
|
|
- Modify the text file NS3<sub>MAIN</sub><sub>PATH</sub>/src/buildings/wscript, as before, in order to include the new files.
|
|
|
- Copy the files `$CUSCUS/mods/ns3-src/src/buildings/model/hybrid-raylight-buildings-propagation-loss-model.cc & .h` into the directory `$NS3_MAIN_PATH/src/buildings/model/`
|
|
|
- Modify the text file `NS3_MAIN_PATH/src/buildings/wscript`, as before, in order to include the new files.
|
|
|
|
|
|
6. install the start scratch (dont' ask why we didn't setup a proper application model, we'll do that later, with all bells and whistles):
|
|
|
- Copy the file CUSCUS/mods/ns3-src/scratch/uavConnectedSimBuildingRaylight.cc in the directory $NS3<sub>MAIN</sub><sub>PATH</sub>/scratch/
|
|
|
- Copy the file `$CUSCUS/mods/ns3-src/scratch/uavConnectedSimBuildingRaylight.cc` in the directory `$NS3_MAIN_PATH/scratch/`
|
|
|
|
|
|
7. Re-compile ns-3 with waf
|
|
|
8. The ns-3 simulator <del>should be</del> is ready
|
|
|
|
|
|
|
|
|
<a id="orgf56de82"></a>
|
|
|
<a id="org0893e25"></a>
|
|
|
|
|
|
## Third Step - Install [FL-AIR](https://www.hds.utc.fr/heudiasyc/production/logiciels-970/logiciels-971/article/fl-air-framework-libre-air-3123?lang=fr) (following the FL-AIR site instructions)
|
|
|
|
... | ... | @@ -121,26 +129,26 @@ Just make sure that you also complete all the substeps in this section: |
|
|
- <del>(problema con la demo OpticalFlow)</del>
|
|
|
- If you like, amuse yourself with the instruction in this [link](https://devel.hds.utc.fr/software/flair/wiki/circlefollower)
|
|
|
- You can use the experience later, to check if you have compiled the programs correctly or not.
|
|
|
- Copy the entire directory CUSCUS/mods/CuscusBasic into $FLAIR<sub>ROOT</sub>/flair-src/demos
|
|
|
- <del>\*Compile the demos with the "flair<sub>compile</sub><sub>all.sh</sub>" script (NICOLA'S Notes: come sopra)</del>
|
|
|
- Copy the entire directory `$CUSCUS/mods/CuscusBasic` into `$FLAIR_ROOT/flair-src/demos`
|
|
|
- <del>\*Compile the demos with the "`flair_compile_all.sh`" script (NICOLA'S Notes: come sopra)</del>
|
|
|
- Follow the same instruction as [here](https://devel.hds.utc.fr/software/flair/wiki/circlefollower)
|
|
|
- **ONLY THE COMPILATION PART** (you don't have to execute anything now)
|
|
|
- It should be ok to run now.
|
|
|
|
|
|
|
|
|
<a id="orgc73873b"></a>
|
|
|
<a id="org1f95cf9"></a>
|
|
|
|
|
|
### Extra - Make sure that
|
|
|
|
|
|
- You have exported $FLAIR<sub>ROOT</sub> and $NS3<sub>MAIN</sub><sub>PATH</sub>
|
|
|
- Modify CUSCUS/mods/scripts/parametersCUSCUS.dat accordingly
|
|
|
- You have exported `$FLAIR_ROOT and $NS3_MAIN_PATH`
|
|
|
- Modify `$CUSCUS/mods/scripts/parametersCUSCUS.dat` accordingly
|
|
|
|
|
|
|
|
|
<a id="org24d56b4"></a>
|
|
|
<a id="orgc4088bf"></a>
|
|
|
|
|
|
## Fourth Step
|
|
|
|
|
|
- run `CUSCUS/mods/scripts/launchCUSCUS.sh`
|
|
|
- run `$CUSCUS/mods/scripts/launchCUSCUS.sh`
|
|
|
- you can use bash or chmod-it into execution (but you have to remember to use bash).
|
|
|
- It should work
|
|
|
- Look out for errors
|
... | ... | |