Skip to content

Commit

Permalink
Update names in Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xxEoD2242 committed Jun 23, 2024
1 parent ae82c6f commit a7ccb0d
Show file tree
Hide file tree
Showing 71 changed files with 668 additions and 668 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
deactivate
- name: Build AirSim Documentation
- name: Build Colosseum Documentation
run: ./build_docs.sh

# Only on commits to 'main' branch
Expand Down
4 changes: 2 additions & 2 deletions PythonClient/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
airsim
=========================================
This page documents `airsim`_, the python package to be used for `Microsoft AirSim`_.
This page documents `airsim`_, the python package to be used for `Microsoft Colosseum`_.

.. _`airsim`: https://pypi.org/project/airsim/
.. _`Microsoft AirSim`: https://github.com/microsoft/AirSim
.. _`Microsoft Colosseum`: https://github.com/CodexLabsLLC/Colosseum

.. toctree::
:maxdepth: 3
Expand Down
256 changes: 128 additions & 128 deletions docs/CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Quick Start
- Please read our [short and sweet coding guidelines](coding_guidelines.md).
- For big changes such as adding new feature or refactoring, [file an issue first](https://github.com/Microsoft/AirSim/issues).
- For big changes such as adding new feature or refactoring, [file an issue first](https://github.com/CodexLabsLLC/Colosseum/issues).
- Use our [recommended development workflow](dev_workflow.md) to make changes and test it.
- Use [usual steps](https://www.dataschool.io/how-to-contribute-on-github/) to make contributions just like other GitHub projects. If you are not familiar with Git Branch-Rebase-Merge workflow, please [read this first](https://git-rebase.io/).

Expand Down
14 changes: 7 additions & 7 deletions docs/InfraredCamera.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
This is a tutorial for generating simulated thermal infrared (IR) images using AirSim and the AirSim Africa environment.
This is a tutorial for generating simulated thermal infrared (IR) images using Colosseum and the Colosseum Africa environment.

Pre-compiled Africa Environment can be downloaded from the Releases tab of this Github repo:
[Windows Pre-compiled binary](https://github.com/Microsoft/AirSim/releases/tag/v1.2.1)
[Windows Pre-compiled binary](https://github.com/CodexLabsLLC/Colosseum/releases/tag/v1.2.1)

To generate your own data, you may use two python files: [create_ir_segmentation_map.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/create_ir_segmentation_map.py) and
[capture_ir_segmentation.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/capture_ir_segmentation.py).
To generate your own data, you may use two python files: [create_ir_segmentation_map.py](https://github.com/CodexLabsLLC/Colosseum/tree/main/PythonClient//computer_vision/create_ir_segmentation_map.py) and
[capture_ir_segmentation.py](https://github.com/CodexLabsLLC/Colosseum/tree/main/PythonClient//computer_vision/capture_ir_segmentation.py).

[create_ir_segmentation_map.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/create_ir_segmentation_map.py) uses temperature, emissivity, and camera response information to estimate the thermal digital count that could be expected for the objects in the environment, and then reassigns the segmentation IDs in AirSim to match these digital counts. It should be run before starting to capture thermal IR data. Otherwise, digital counts in the IR images will be incorrect. The camera response, temperature, and emissivity data are all included for the Africa environment.
[create_ir_segmentation_map.py](https://github.com/CodexLabsLLC/Colosseum/tree/main/PythonClient//computer_vision/create_ir_segmentation_map.py) uses temperature, emissivity, and camera response information to estimate the thermal digital count that could be expected for the objects in the environment, and then reassigns the segmentation IDs in Colosseum to match these digital counts. It should be run before starting to capture thermal IR data. Otherwise, digital counts in the IR images will be incorrect. The camera response, temperature, and emissivity data are all included for the Africa environment.

[capture_ir_segmentation.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision/capture_ir_segmentation.py) is run after the segmentation IDs have been reassigned. It tracks objects of interest and records the infrared and scene images from the multirotor. It uses Computer Vision mode.
[capture_ir_segmentation.py](https://github.com/CodexLabsLLC/Colosseum/tree/main/PythonClient//computer_vision/capture_ir_segmentation.py) is run after the segmentation IDs have been reassigned. It tracks objects of interest and records the infrared and scene images from the multirotor. It uses Computer Vision mode.

Finally, the details about how temperatures were estimated for plants and animals in the Africa environment, etc. can be found in this paper:

@inproceedings{bondi2018airsim,
title={AirSim-W: A Simulation Environment for Wildlife Conservation with UAVs},
title={Colosseum-W: A Simulation Environment for Wildlife Conservation with UAVs},
author={Bondi, Elizabeth and Dey, Debadeepta and Kapoor, Ashish and Piavis, Jim and Shah, Shital and Fang, Fei and Dilkina, Bistra and Hannaford, Robert and Iyer, Arvind and Joppa, Lucas and others},
booktitle={Proceedings of the 1st ACM SIGCAS Conference on Computing and Sustainable Societies},
pages={40},
Expand Down
6 changes: 3 additions & 3 deletions docs/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

We highly recommend to take a look at source code and contribute to the project. Due to large number of incoming feature request we may not be able to get to your request in your desired timeframe. So please [contribute](CONTRIBUTING.md) :).

* [Ask in Discussions](https://github.com/microsoft/AirSim/discussions)
* [File GitHub Issue](https://github.com/Microsoft/AirSim/issues)
* [Join AirSim Facebook Group](https://www.facebook.com/groups/1225832467530667/)
* [Ask in Discussions](https://github.com/CodexLabsLLC/Colosseum/discussions)
* [File GitHub Issue](https://github.com/CodexLabsLLC/Colosseum/issues)
* [Join Colosseum Facebook Group](https://www.facebook.com/groups/1225832467530667/)
30 changes: 15 additions & 15 deletions docs/Unity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AirSim on Unity
# Colosseum on Unity

* AirSim on Unity allows you to run your simulators in the [Unity Engine](https://unity3d.com/). This project comes with some sample Unity projects and a wrapper around the AirLib library to run as a [native plugin](https://docs.unity3d.com/Manual/NativePlugins.html) in Unity.
* Colosseum on Unity allows you to run your simulators in the [Unity Engine](https://unity3d.com/). This project comes with some sample Unity projects and a wrapper around the AirLib library to run as a [native plugin](https://docs.unity3d.com/Manual/NativePlugins.html) in Unity.
* Included are two basic Unity Projects, one for a Car simulator and another for a Drone simulator. They are meant to be lightweight, and can be used to verify your setup is correct.
* Check out the [Unity blogpost](https://blogs.unity3d.com/2018/11/14/airsim-on-unity-experiment-with-autonomous-vehicle-simulation/) for overview on the release.

Expand All @@ -19,11 +19,11 @@ This project is still in early development, expect some rough edges. We are work
**Make sure** to select **Desktop Development with C++** and **Windows 10 SDK 10.0.18362** (should be selected by default) while installing VS 2019.

* Start `x64 Native Tools Command Prompt for VS 2019`.
* Clone the repo: `git clone https://github.com/Microsoft/AirSim.git`, and go the AirSim directory by `cd AirSim`.
* Clone the repo: `git clone https://github.com/CodexLabsLLC/Colosseum.git`, and go the Colosseum directory by `cd Colosseum`.
* Run `build.cmd` from the command line.

#### Build Unity Project
* Go inside the AirSim\Unity directory: `cd Unity`.
* Go inside the Colosseum\Unity directory: `cd Unity`.
* Build the unity project: `build.cmd`.
* Additionally, there is a free environment `Windridge City` which you can download from [Unity Asset Store](https://assetstore.unity.com/packages/3d/environments/roadways/windridge-city-132222). And, of course, you can always create your own environment.

Expand All @@ -42,40 +42,40 @@ sudo apt-get install libboost-all-dev

#### Build Airsim
```
git clone https://github.com/Microsoft/AirSim.git;
cd AirSim;
git clone https://github.com/CodexLabsLLC/Colosseum.git;
cd Colosseum;
./setup.sh;
./build.sh
```

#### Generate AirsimWrapper Shared Library
```
cd AirSim/Unity
cd Colosseum/Unity
./build.sh
```

This will generate the necessary shared library and copy it to the UnityDemo Plugins folder.

## Usage
* Start Unity Hub, click on `Projects` on left pane, and then click on the `Add` button
* Select the folder `AirSim\Unity\UnityDemo`, and then hit the `OK` button.
* Select the folder `Colosseum\Unity\UnityDemo`, and then hit the `OK` button.
* Click on the new project which showed up in the Unity Hub menu to open it in Unity.
* In the bottom pane, click on `Projects`->`Assets`->`Scenes`. Then, **Double-click** on `SimModeSelector`. This will load the SimModeSelector scene into the scene hierarchy pane. *DO NOT* add CarDemo or DroneDemo scene into the scene hierarchy pane.
* Hit the play button to start the simulation (and hit play again to stop the simulation. .
* Alternatively, you can change the SimMode in your `Settings.json` file. (You can read more about [`Settings.json` here](settings.md))
* Controlling the car:
Use `WASD` or the `Arrow keys` or the AirSim client.
Use `WASD` or the `Arrow keys` or the Colosseum client.
* Controlling the drone:
Keyboard control is not currently available for drone flight.
* Changing camera views:
Keys `0`, `1`, `2`, `3` are used to toggle windows of different camera views.
* Recording simulation data:
Press *Record* button(Red button) located at the right bottom corner of the screen, to toggle recording of the simulation data. The recorded data can be found at `Documents\AirSim\(Date of recording)` on Windows and `~/Documents/AirSim/(Date of recording)` on Linux.
## Building Custom Environments For AirSim
Press *Record* button(Red button) located at the right bottom corner of the screen, to toggle recording of the simulation data. The recorded data can be found at `Documents\Colosseum\(Date of recording)` on Windows and `~/Documents/Colosseum/(Date of recording)` on Linux.
## Building Custom Environments For Colosseum
To use environments other than `UnityDemo`, follow the instructions written [here](custom_unity_environments.md)
## Cross-Compiling to Linux
Unity Editor supports compiling projects to Linux systems.
After following the steps to build AirSim and Unity on Windows, do the following:
After following the steps to build Colosseum and Unity on Windows, do the following:

#### Linux Pre-Requisites
Before being able to run Unity Binaries with the Airsim plugin, be sure have airsim and airsim unity built on your linux machine by following the Linux build steps above.
Expand All @@ -101,7 +101,7 @@ Once this component is successfully installed, you are ready to build Unity Proj
* Transport the built project as well as the generated folder ```"{project_name}_Data"``` to your linux machine

#### Copy The AirsimWrapper Library to the Project Plugins folder
* On your linux machine, navigate to your AirSim repository, and run the following commands in a terminal window:
* On your linux machine, navigate to your Colosseum repository, and run the following commands in a terminal window:
```
cp Unity/linux-build/libAirsimWrapper.so path/to/your/project/{project_name}_Data/Plugins/{os_version}
```
Expand All @@ -118,8 +118,8 @@ chmod +x "{project_name}.{configuration}"
./{project_name}.{configuration}
```
### Using Airsim API
* For quickstart with the Python APIs for the car or the drone, simply run the [`hello_car.py`](https://github.com/Microsoft/AirSim/blob/main/PythonClient/car/hello_car.py) or the [`hello_drone.py`](https://github.com/Microsoft/AirSim/blob/main/PythonClient/multirotor/hello_drone.py) script accordingly.
* Details of the AirSim C++ and Python APIs are [here](apis.md).
* For quickstart with the Python APIs for the car or the drone, simply run the [`hello_car.py`](https://github.com/CodexLabsLLC/Colosseum/blob/main/PythonClient/car/hello_car.py) or the [`hello_drone.py`](https://github.com/CodexLabsLLC/Colosseum/blob/main/PythonClient/multirotor/hello_drone.py) script accordingly.
* Details of the Colosseum C++ and Python APIs are [here](apis.md).

### Acknowledgements
* The drone object was provided by user 31415926 on [sketchfab](https://sketchfab.com/models/055841df0fb24cd4abde06a91f7d360a). It is licensed under the [CC License](https://creativecommons.org/licenses/by/4.0/).
Loading

0 comments on commit a7ccb0d

Please sign in to comment.