afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #808 from coreemu/develop

Browse source 
fix issues with updated documentation
This commit is contained in:
bharnden 2023-08-01 10:18:11 -07:00 committed by GitHub
commit 20071eed2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 49 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/tutorials/common/grpc.md
View file

@ -18,5 +18,5 @@ the remaining steps of a given section.
``` ```
4. You will be presented with sessions to join, select the one created by the script 4. You will be presented with sessions to join, select the one created by the script
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-join.png" width="75%"> <img src="/core/static/tutorial-common/running-join.png" width="75%">
</p> </p>

26
docs/tutorials/tutorial1.md
View file

@ -6,7 +6,7 @@ This tutorial will cover some use cases when using a wired 2 node
scenario in CORE. scenario in CORE.
<p align="center"> <p align="center">
<img src="/static/tutorial1/scenario.png" width="75%"> <img src="/core/static/tutorial1/scenario.png" width="75%">
</p> </p>
## Files ## Files
@ -46,11 +46,11 @@ between nodes in CORE.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial1/scenario.png" width="75%"> <img src="/core/static/tutorial1/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n1** by double clicking it in the GUI * Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal * Run the following in **n1** terminal
@ -84,11 +84,11 @@ traffic being sent/received among many other uses.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial1/scenario.png" width="75%"> <img src="/core/static/tutorial1/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n1** by double clicking it in the GUI * Open a terminal on **n1** by double clicking it in the GUI
* Open a terminal on **n2** by double clicking it in the GUI * Open a terminal on **n2** by double clicking it in the GUI
@ -123,20 +123,20 @@ beneficial for understanding how software will behave in adverse conditions.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial1/scenario.png" width="75%"> <img src="/core/static/tutorial1/scenario.png" width="75%">
</p> </p>
* Right click the link between **n1** and **n2** * Right click the link between **n1** and **n2**
* Select **Configure** * Select **Configure**
<p align="center"> <p align="center">
<img src="/static/tutorial1/link-config.png" width="75%"> <img src="/core/static/tutorial1/link-config.png" width="75%">
</p> </p>
* Update the loss to **25** * Update the loss to **25**
<p align="center"> <p align="center">
<img src="/static/tutorial1/link-config-dialog.png" width="50%"> <img src="/core/static/tutorial1/link-config-dialog.png" width="50%">
</p> </p>
* Open a terminal on **n1** by double clicking it in the GUI * Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal * Run the following in **n1** terminal
@ -166,11 +166,11 @@ within the nodes of our scenario.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial1/scenario.png" width="75%"> <img src="/core/static/tutorial1/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n1** by double clicking it in the GUI * Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal * Run the following in **n1** terminal
@ -216,11 +216,11 @@ using `tail -f` to observe the output of running software.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial1/scenario.png" width="75%"> <img src="/core/static/tutorial1/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n1** by double clicking it in the GUI * Open a terminal on **n1** by double clicking it in the GUI
* Run the following in **n1** terminal * Run the following in **n1** terminal

8
docs/tutorials/tutorial2.md
View file

@ -30,7 +30,7 @@ XML scenario file, leveraging an NS2 mobility file.
* Navigate to and select this tutorials **scenario.xml** file * Navigate to and select this tutorials **scenario.xml** file
* You can now click play to start the session * You can now click play to start the session
<p align="center"> <p align="center">
<img src="/static/tutorial2/wireless.png" width="75%"> <img src="/core/static/tutorial2/wireless.png" width="75%">
</p> </p>
* Note that OSPF routing protocol is included in the scenario to provide routes to other nodes, as they are discovered * Note that OSPF routing protocol is included in the scenario to provide routes to other nodes, as they are discovered
* Double click node **n4** to open a terminal and ping node **n2** * Double click node **n4** to open a terminal and ping node **n2**
@ -49,7 +49,7 @@ XML scenario file, leveraging an NS2 mobility file.
* Right click on the **wlan1** node and select **WLAN Config**, then set delay to 500000 * Right click on the **wlan1** node and select **WLAN Config**, then set delay to 500000
<p align="center"> <p align="center">
<img src="/static/tutorial2/wireless-config-delay.png" width="90%"> <img src="/core/static/tutorial2/wireless-config-delay.png" width="90%">
</p> </p>
* Using the open terminal for node **n4**, ping **n2** again, expect about 2 seconds delay * Using the open terminal for node **n4**, ping **n2** again, expect about 2 seconds delay
```shell ```shell
@ -69,7 +69,7 @@ XML scenario file, leveraging an NS2 mobility file.
* Right click on the **wlan1** node and select **WLAN Config**, set delay back to 5000 and loss to 10 * Right click on the **wlan1** node and select **WLAN Config**, set delay back to 5000 and loss to 10
<p align="center"> <p align="center">
<img src="/static/tutorial2/wireless-configuration.png" width="90%"> <img src="/core/static/tutorial2/wireless-configuration.png" width="90%">
</p> </p>
* Using the open terminal for node **n4**, ping **n2** again, expect to notice considerable loss * Using the open terminal for node **n4**, ping **n2** again, expect to notice considerable loss
```shell ```shell
@ -111,7 +111,7 @@ gRPC python script and providing mobility over the gRPC interface.
* You will now have joined the already running scenario * You will now have joined the already running scenario
<p align="center"> <p align="center">
<img src="/static/tutorial2/wireless.png" width="90%"> <img src="/core/static/tutorial2/wireless.png" width="90%">
</p> </p>
## Running Software ## Running Software

8
docs/tutorials/tutorial3.md
View file

@ -71,7 +71,7 @@ file, leveraging an NS2 file for mobility.
known and when the routes are discovered, ping will work known and when the routes are discovered, ping will work
<p align="center"> <p align="center">
<img src="/static/tutorial3/motion_from_ns2_file.png" width="80%" > <img src="/core/static/tutorial3/motion_from_ns2_file.png" width="80%" >
</p> </p>
## Running with the gRPC Script ## Running with the gRPC Script
@ -94,11 +94,11 @@ This section covers using a gRPC script to create and provide scenario movement.
* You will now have joined the already running scenario * You will now have joined the already running scenario
* In the terminal running the **scenario.py**, hit a key to start motion * In the terminal running the **scenario.py**, hit a key to start motion
<p align="center"> <p align="center">
<img src="/static/tutorial3/mobility-script.png" width="80%" > <img src="/core/static/tutorial3/mobility-script.png" width="80%" >
</p> </p>
* Observe the link between **n3** and **n4** is shown and then as motion continues the link breaks * Observe the link between **n3** and **n4** is shown and then as motion continues the link breaks
<p align="center"> <p align="center">
<img src="/static/tutorial3/motion_continued_breaks_link.png" width="80%" > <img src="/core/static/tutorial3/motion_continued_breaks_link.png" width="80%" >
</p> </p>
## Running the Chat App Software ## Running the Chat App Software
@ -151,5 +151,5 @@ API.
* Observe that node 2 moves and continues to move * Observe that node 2 moves and continues to move
<p align="center"> <p align="center">
<img src="/static/tutorial3/move-n2.png" width="80%" > <img src="/core/static/tutorial3/move-n2.png" width="80%" >
</p> </p>

12
docs/tutorials/tutorial5.md
View file

@ -18,7 +18,7 @@ This section covers using the saved **scenario.xml** file to get and up and runn
* Configure the Windows host VM to have a bridged network adapter * Configure the Windows host VM to have a bridged network adapter
<p align="center"> <p align="center">
<img src="/static/tutorial5/VM-network-settings.png" width="80%"> <img src="/core/static/tutorial5/VM-network-settings.png" width="80%">
</p> </p>
* Make sure the **core-daemon** is running in a terminal * Make sure the **core-daemon** is running in a terminal
```shell ```shell
@ -30,15 +30,15 @@ This section covers using the saved **scenario.xml** file to get and up and runn
``` ```
* Open the **scenario.xml** with the unassigned RJ45 node * Open the **scenario.xml** with the unassigned RJ45 node
<p align="center"> <p align="center">
<img src="/static/tutorial5/rj45-unassigned.png" width="80%"> <img src="/core/static/tutorial5/rj45-unassigned.png" width="80%">
</p> </p>
* Configure the RJ45 node name to use the bridged interface * Configure the RJ45 node name to use the bridged interface
<p align="center"> <p align="center">
<img src="/static/tutorial5/configure-the-rj45.png" width="80%"> <img src="/core/static/tutorial5/configure-the-rj45.png" width="80%">
</p> </p>
* After configuring the RJ45, run the scenario: * After configuring the RJ45, run the scenario:
<p align="center"> <p align="center">
<img src="/static/tutorial5/rj45-connector.png" width="80%"> <img src="/core/static/tutorial5/rj45-connector.png" width="80%">
</p> </p>
* Double click node **n1** to open a terminal and add a route to the Windows host * Double click node **n1** to open a terminal and add a route to the Windows host
```shell ```shell
@ -97,7 +97,7 @@ This section covers leveraging the gRPC script to get up and running.
* Configure the Windows host VM to have a bridged network adapter * Configure the Windows host VM to have a bridged network adapter
<p align="center"> <p align="center">
<img src="/static/tutorial5/VM-network-settings.png" width="80%"> <img src="/core/static/tutorial5/VM-network-settings.png" width="80%">
</p> </p>
* Make sure the **core-daemon** is running in a terminal * Make sure the **core-daemon** is running in a terminal
```shell ```shell
@ -114,7 +114,7 @@ This section covers leveraging the gRPC script to get up and running.
``` ```
* In the **core-gui** connect to the running session that was created * In the **core-gui** connect to the running session that was created
<p align="center"> <p align="center">
<img src="/static/tutorial5/rj45-connector.png" width="80%"> <img src="/core/static/tutorial5/rj45-connector.png" width="80%">
</p> </p>
* Double click node **n1** to open a terminal and add a route to the Windows host * Double click node **n1** to open a terminal and add a route to the Windows host
```shell ```shell

18
docs/tutorials/tutorial6.md
View file

@ -31,11 +31,11 @@ This section will cover running this sample tutorial that develops a scenario fi
* Create three MDR nodes * Create three MDR nodes
<p align="center"> <p align="center">
<img src="/static/tutorial6/create-nodes.png" width="80%"> <img src="/core/static/tutorial6/create-nodes.png" width="80%">
</p> </p>
* Double click on each node for configuration, click the icon and set it to use the **drone.png** image * Double click on each node for configuration, click the icon and set it to use the **drone.png** image
<p align="center"> <p align="center">
<img src="/static/tutorial6/configure-icon.png" width="50%"> <img src="/core/static/tutorial6/configure-icon.png" width="50%">
</p> </p>
* Use **Session -> Options** and set **Control Network 0** to **172.16.0.0./24** * Use **Session -> Options** and set **Control Network 0** to **172.16.0.0./24**
@ -44,30 +44,30 @@ This section will cover running this sample tutorial that develops a scenario fi
* Add a WLAN Node * Add a WLAN Node
* Link the three prior MDR nodes to the WLAN node * Link the three prior MDR nodes to the WLAN node
<p align="center"> <p align="center">
<img src="/static/tutorial6/linked-nodes.png" width="50%"> <img src="/core/static/tutorial6/linked-nodes.png" width="50%">
</p> </p>
* Click play to start the scenario * Click play to start the scenario
* Observe wireless links being created * Observe wireless links being created
<p align="center"> <p align="center">
<img src="/static/tutorial6/wlan-links.png" width="50%"> <img src="/core/static/tutorial6/wlan-links.png" width="50%">
</p> </p>
* Click stop to end the scenario * Click stop to end the scenario
* Right click the WLAN node and select **Edit -> Hide** * Right click the WLAN node and select **Edit -> Hide**
* Now you can view the nodes in isolation * Now you can view the nodes in isolation
<p align="center"> <p align="center">
<img src="/static/tutorial6/hidden-nodes.png" width="50%"> <img src="/core/static/tutorial6/hidden-nodes.png" width="50%">
</p> </p>
### Changing Canvas Background ### Changing Canvas Background
* Click **Canvas -> Wallpaper** to set the background to terrain.png * Click **Canvas -> Wallpaper** to set the background to terrain.png
<p align="center"> <p align="center">
<img src="/static/tutorial6/select-wallpaper.png" width="50%"> <img src="/core/static/tutorial6/select-wallpaper.png" width="50%">
</p> </p>
* Click play to start the scenario again * Click play to start the scenario again
* You now have a scenario with drone icons, terrain background, links displayed and hidden WLAN node * You now have a scenario with drone icons, terrain background, links displayed and hidden WLAN node
<p align="center"> <p align="center">
<img src="/static/tutorial6/scenario-with-terrain.png" width="80%"> <img src="/core/static/tutorial6/scenario-with-terrain.png" width="80%">
</p> </p>
## Adding Mobility ## Adding Mobility
@ -80,7 +80,7 @@ This section will cover running this sample tutorial that develops a scenario fi
``` ```
* Let it run to see the link break as the node 1 drone approches the right side * Let it run to see the link break as the node 1 drone approches the right side
<p align="center"> <p align="center">
<img src="/static/tutorial6/only-node1-moving.png" width="80%"> <img src="/core/static/tutorial6/only-node1-moving.png" width="80%">
</p> </p>
* Repeat for other nodes, double click on **n2** and **n3** and run the demo.py script * Repeat for other nodes, double click on **n2** and **n3** and run the demo.py script
```shell ```shell
@ -93,5 +93,5 @@ This section will cover running this sample tutorial that develops a scenario fi
* Observe nodes moving in parallel tracks, when the far right is reached, the node will move down * Observe nodes moving in parallel tracks, when the far right is reached, the node will move down
and then move to the left. When the far left is reached, the drone will move down and then move to the right. and then move to the left. When the far left is reached, the drone will move down and then move to the right.
<p align="center"> <p align="center">
<img src="/static/tutorial6/scenario-with-motion.png" width="80%"> <img src="/core/static/tutorial6/scenario-with-motion.png" width="80%">
</p> </p>

18
docs/tutorials/tutorial7.md
View file

@ -6,7 +6,7 @@ This tutorial will cover basic usage and some concepts one may want to
use or leverage when working with and creating EMANE based networks. use or leverage when working with and creating EMANE based networks.
<p align="center"> <p align="center">
<img src="/static/tutorial7/scenario.png" width="75%"> <img src="/core/static/tutorial7/scenario.png" width="75%">
</p> </p>
For more detailed information on EMANE see the following: For more detailed information on EMANE see the following:
@ -52,11 +52,11 @@ between nodes in CORE.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial7/scenario.png" width="75%"> <img src="/core/static/tutorial7/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n2** by double clicking it in the GUI * Open a terminal on **n2** by double clicking it in the GUI
* Run the following in **n2** terminal * Run the following in **n2** terminal
@ -90,11 +90,11 @@ traffic being sent/received among many other uses.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial7/scenario.png" width="75%"> <img src="/core/static/tutorial7/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n2** by double clicking it in the GUI * Open a terminal on **n2** by double clicking it in the GUI
* Open a terminal on **n3** by double clicking it in the GUI * Open a terminal on **n3** by double clicking it in the GUI
@ -129,11 +129,11 @@ within the nodes of our scenario.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial7/scenario.png" width="75%"> <img src="/core/static/tutorial7/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n2** by double clicking it in the GUI * Open a terminal on **n2** by double clicking it in the GUI
* Run the following in **n2** terminal * Run the following in **n2** terminal
@ -179,11 +179,11 @@ using `tail -f` to observe the output of running software.
``` ```
* In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml** * In the GUI menu bar select **File->Open...**, then navigate to and select **scenario_service.xml**
<p align="center"> <p align="center">
<img src="/static/tutorial-common/running-open.png" width="75%"> <img src="/core/static/tutorial-common/running-open.png" width="75%">
</p> </p>
* You can now click on the **Start Session** button to run the scenario * You can now click on the **Start Session** button to run the scenario
<p align="center"> <p align="center">
<img src="/static/tutorial7/scenario.png" width="75%"> <img src="/core/static/tutorial7/scenario.png" width="75%">
</p> </p>
* Open a terminal on **n2** by double clicking it in the GUI * Open a terminal on **n2** by double clicking it in the GUI
* Run the following in **n2** terminal * Run the following in **n2** terminal

3
mkdocs.yml
View file

@ -1,4 +1,7 @@
site_name: CORE Documentation site_name: CORE Documentation
site_url: https://coreemu.github.io/core
repo_name: coreemu/core
repo_url: https://github.com/coreemu/core
use_directory_urls: false use_directory_urls: false
theme: theme:
name: material name: material