forked from microsoft/AirSim
-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
0 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,142 +57,6 @@ Click [here](https://docs.google.com/document/d/1doohQTos4v1tg4Wv6SliQFnKNK1MouK | |
| If you want to be apart of the official development team, attend meetings, etc., please utilize the Slack channel (link above) and | ||
| let Tyler Fedrizzi know! | ||
|
|
||
| **Check out the quick 1.5 minute demo** | ||
|
|
||
| Quadrotor UAVs in Colosseum | ||
|
|
||
| [](https://youtu.be/-WfTr1-OBGQ) | ||
|
|
||
| Cars in Colosseum | ||
|
|
||
| [](https://youtu.be/gnz1X3UNM5Y) | ||
|
|
||
|
|
||
| ## How to Get It | ||
|
|
||
| ### Windows | ||
| [](https://github.com/microsoft/AirSim/actions/workflows/test_windows.yml) | ||
| * [Download binaries](https://github.com/Microsoft/AirSim/releases) | ||
| * [Build it](https://microsoft.github.io/AirSim/build_windows) | ||
|
|
||
| ### Linux | ||
| [](https://github.com/microsoft/AirSim/actions/workflows/test_ubuntu.yml) | ||
| * [Download binaries](https://github.com/Microsoft/AirSim/releases) | ||
| * [Build it](https://microsoft.github.io/AirSim/build_linux) | ||
|
|
||
| ### macOS | ||
| [](https://github.com/microsoft/AirSim/actions/workflows/test_macos.yml) | ||
| * [Build it](https://microsoft.github.io/AirSim/build_macos) | ||
|
|
||
| For more details, see the [use precompiled binaries](docs/use_precompiled.md) document. | ||
|
|
||
| ## How to Use It | ||
|
|
||
| ### Documentation | ||
|
|
||
| View our [detailed documentation](https://microsoft.github.io/AirSim/) on all aspects of Colosseum. | ||
|
|
||
| ### Manual drive | ||
|
|
||
| If you have remote control (RC) as shown below, you can manually control the drone in the simulator. For cars, you can use arrow keys to drive manually. | ||
|
|
||
| [More details](https://microsoft.github.io/AirSim/remote_control) | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### Programmatic control | ||
|
|
||
| Colosseum exposes APIs so you can interact with the vehicle in the simulation programmatically. You can use these APIs to retrieve images, get state, control the vehicle and so on. The APIs are exposed through the RPC, and are accessible via a variety of languages, including C++, Python, C# and Java. | ||
|
|
||
| These APIs are also available as part of a separate, independent cross-platform library, so you can deploy them on a companion computer on your vehicle. This way you can write and test your code in the simulator, and later execute it on the real vehicles. Transfer learning and related research is one of our focus areas. | ||
|
|
||
| Note that you can use [SimMode setting](https://microsoft.github.io/AirSim/settings#simmode) to specify the default vehicle or the new [ComputerVision mode](https://microsoft.github.io/AirSim/image_apis#computer-vision-mode-1) so you don't get prompted each time you start Colosseum. | ||
|
|
||
| [More details](https://microsoft.github.io/AirSim/apis) | ||
|
|
||
| ### Gathering training data | ||
|
|
||
| There are two ways you can generate training data from Colosseum for deep learning. The easiest way is to simply press the record button in the lower right corner. This will start writing pose and images for each frame. The data logging code is pretty simple and you can modify it to your heart's content. | ||
|
|
||
|  | ||
|
|
||
| A better way to generate training data exactly the way you want is by accessing the APIs. This allows you to be in full control of how, what, where and when you want to log data. | ||
|
|
||
| ### Computer Vision mode | ||
|
|
||
| Yet another way to use Colosseum is the so-called "Computer Vision" mode. In this mode, you don't have vehicles or physics. You can use the keyboard to move around the scene, or use APIs to position available cameras in any arbitrary pose, and collect images such as depth, disparity, surface normals or object segmentation. | ||
|
|
||
| [More details](https://microsoft.github.io/AirSim/image_apis) | ||
|
|
||
| ### Weather Effects | ||
|
|
||
| Press F10 to see various options available for weather effects. You can also control the weather using [APIs](https://microsoft.github.io/AirSim/apis#weather-apis). Press F1 to see other options available. | ||
|
|
||
|  | ||
|
|
||
| ## Tutorials | ||
|
|
||
| - [Video - Setting up Colosseum with Pixhawk Tutorial](https://youtu.be/1oY8Qu5maQQ) by Chris Lovett | ||
| - [Video - Using Colosseum with Pixhawk Tutorial](https://youtu.be/HNWdYrtw3f0) by Chris Lovett | ||
| - [Video - Using off-the-self environments with Colosseum](https://www.youtube.com/watch?v=y09VbdQWvQY) by Jim Piavis | ||
| - [Webinar - Harnessing high-fidelity simulation for autonomous systems](https://note.microsoft.com/MSR-Webinar-AirSim-Registration-On-Demand.html) by Sai Vemprala | ||
| - [Reinforcement Learning with Colosseum](https://microsoft.github.io/AirSim/reinforcement_learning) by Ashish Kapoor | ||
| - [The Autonomous Driving Cookbook](https://aka.ms/AutonomousDrivingCookbook) by Microsoft Deep Learning and Robotics Garage Chapter | ||
| - [Using TensorFlow for simple collision avoidance](https://github.com/simondlevy/AirSimTensorFlow) by Simon Levy and WLU team | ||
|
|
||
| ## Participate | ||
|
|
||
| ### Paper | ||
|
|
||
| More technical details are available in [Colosseum paper (FSR 2017 Conference)](https://arxiv.org/abs/1705.05065). Please cite this as: | ||
| ``` | ||
| @inproceedings{airsim2017fsr, | ||
| author = {Shital Shah and Debadeepta Dey and Chris Lovett and Ashish Kapoor}, | ||
| title = {AirSim: High-Fidelity Visual and Physical Simulation for Autonomous Vehicles}, | ||
| year = {2017}, | ||
| booktitle = {Field and Service Robotics}, | ||
| eprint = {arXiv:1705.05065}, | ||
| url = {https://arxiv.org/abs/1705.05065} | ||
| } | ||
| ``` | ||
|
|
||
| ### Contribute | ||
|
|
||
| Please take a look at [open issues](https://github.com/microsoft/airsim/issues) if you are looking for areas to contribute to. | ||
|
|
||
| * [More on Colosseum design](https://microsoft.github.io/AirSim/design) | ||
| * [More on code structure](https://microsoft.github.io/AirSim/code_structure) | ||
| * [Contribution Guidelines](CONTRIBUTING.md) | ||
|
|
||
| ### Who is Using Colosseum? | ||
|
|
||
| We are maintaining a [list](https://microsoft.github.io/AirSim/who_is_using) of a few projects, people and groups that we are aware of. If you would like to be featured in this list please [make a request here](https://github.com/CodexLabsLLC/Colosseum/issues). | ||
|
|
||
| ## Contact | ||
|
|
||
| Join our [GitHub Discussions group](https://github.com/microsoft/AirSim/discussions) to stay up to date or ask any questions. | ||
|
|
||
| We also have an Colosseum group on [Facebook](https://www.facebook.com/groups/1225832467530667/). | ||
|
|
||
|
|
||
| ## What's New | ||
|
|
||
| * [Experimental Support for Unreal Engine 5.0.3](https://github.com/CodexLabsLLC/Colosseum/tree/ue5) | ||
|
|
||
| For complete list of changes, view our [Changelog](docs/CHANGELOG.md) | ||
|
|
||
| ## FAQ | ||
|
|
||
| If you run into problems, check the [FAQ](https://codexlabsllc.github.io/Colosseum/faq) and feel free to post issues in the [Colosseum](https://github.com/CodexLabsLLC/Colosseum/issues) repository. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| This project is released under the MIT License. Please review the [License file](LICENSE) for more details. | ||
|
|
||