зеркало из https://github.com/microsoft/AirSim.git
readme and license update
This commit is contained in:
Родитель
f12164aea0
Коммит
2bfaa496fc
25
LICENSE
25
LICENSE
|
@ -1,21 +1,12 @@
|
|||
MIT License
|
||||
MSR Aerial Informatics and Robotics Platform
|
||||
MSR Aerial Informatics and Robotics Simulator (AirSim)
|
||||
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
Copyright (c) Microsoft Corporation
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
All rights reserved.
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
MIT License
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
51
README.md
51
README.md
|
@ -1,48 +1,51 @@
|
|||
# Welcome to AirSim
|
||||
|
||||
AirSim is a simulator for drones (and soon other vehicles) built on Unreal Engine. Its open source,
|
||||
cross platform and supports hardware-in-loop with popular platforms such as PixHawk for physically
|
||||
and visually realistic simulations. It is developed as Unreal plugin that can be just dropped in to any
|
||||
Unreal environment you want. It also exposes APIs so you can retrieve sensor data, ground truth and camera
|
||||
images from the simulator as well as send control commands to the vehicle. Our goal is to develop AirSim as
|
||||
a platform for AI research where we can experiment with deep learning and reinforcement learning algorithms
|
||||
for autonomous vehicles.
|
||||
AirSim is a simulator for drones (and soon other vehicles) built on Unreal Engine. Its open source, cross platform and supports hardware-in-loop with popular platforms such as PixHawk for physically and visually realistic simulations. It is developed as Unreal plugin that can simply be dropped in to any environment you want.
|
||||
|
||||
Our goal is to develop AirSim as a platform for AI research where we can experiment with deep learning, computer vision and reinforcement learning algorithms for autonomous vehicles. For this purpose, AirSim also exposes APIs so you can retrieve sensor data, ground truth and camera images from the simulator. The APIs can also be used to send control commands to the vehicle in platform independent way.
|
||||
|
||||
[![AirSim Demo Video](docs/images/demo_video.png)](https://youtu.be/-WfTr1-OBGQ)
|
||||
|
||||
# Development Status
|
||||
|
||||
This project is under active development. While we are working through our backlog of new features and known issues,
|
||||
we welcome contributions! Our current release is in beta and our APIs are subject to change.
|
||||
This project is under heavy development. While we are working through our backlog of new features and known issues, we welcome contributions! Our current release is in beta and our APIs are subject to change.
|
||||
|
||||
# How to Get It
|
||||
## Prerequisites
|
||||
Currently, to get the best experience you will need PixHawk or compatible PX4 based device and a RC controller.
|
||||
These enable so called "hardware-in-loop (HITL) simulation" that provides more realistic experience.
|
||||
[Follow these instructions](docs/hil_setup.md) on how to get it, set it up and other alternatives.
|
||||
To get the best experience you will need PixHawk or compatible device and a RC controller. These enables so called "hardware-in-loop simulation" that provides more realistic experience. [Follow these instructions](docs/hil_setup.md) on how to get it, set it up and other alternatives.
|
||||
|
||||
## Windows
|
||||
There are two ways to get AirSim working on your machine.
|
||||
There are two ways to get AirSim working on your machine. Click on below links and follow the instructions.
|
||||
|
||||
1. [Use the precompiled binaries](docs/use_precompiled.md)
|
||||
2. [Build it yourself](docs/build.md)
|
||||
1. [Build it and use it with Unreal](docs/build.md)
|
||||
2. [Use the precompiled binaries](docs/use_precompiled.md)
|
||||
|
||||
We recommend option 2 if you are want to use the Unreal plugin in your own environment.
|
||||
|
||||
#Linux
|
||||
All our current code is cross-platform and CMake enabled. We are working on to iron out few rough edges for our
|
||||
official Linux build and expect to release it around next two weeks. Meanwhile, please feel free to play around
|
||||
on other operating systems and report any issues. We had love to make AirSim available on as many platforms as possible.
|
||||
## Linux
|
||||
The official Linux build is expected to arrive in about couple of weeks. All our current code is cross-platform and CMake enabled so please feel free to playaround on other opearting systems and report any issues. We had love to make AirSim available on other platforms as well.
|
||||
|
||||
# How to Use It
|
||||
|
||||
## Manual flights
|
||||
Just plugin PixHawk or compatible device in your USB port, turn on RC and press Play button in Unreal. You should be able to control drone in the simulator with RC and fly around. Press F1 key to view several available keyboard shortcuts.
|
||||
|
||||
[More detailed instructions and troubleshooting](docs/manual_flight.md)
|
||||
|
||||
## Gathering training data
|
||||
There are two ways you can generate training data from AirSim. The easiest way is to simply press the record button on the lower right corner. This will start writing pose and images for each frame. If you had like more data and other features, [file the feature request](issues/) or contribute changes. The code for data logging is pretty simple to modify to your heart's desire.
|
||||
|
||||
## Programmatic control
|
||||
More complex way to generate training data is by writing client code that uses our APIs. This allows you to be in full control of how, what, where and when you want to log data. See next section for more details.
|
||||
|
||||
## Programatic control
|
||||
The AirSim exposes easy to use APIs to retrive data from the drone that includes ground truth, sensor data as well as various images. It also exposes APIs to control the drone in platform independent way. This allows you to use your code to control different drone platforms, for example, PixHawk or DJI Matrice, without any changes. These APIs are also available as seprate independent cross-platform library so you can deploy them on offboard computer on your vehicle and execute same code in real drone that you tested in simulator.
|
||||
|
||||
[More detailed instructions using APIs](docs/apis.md)
|
||||
|
||||
# Contribute
|
||||
We welcome contributions to help advance research frontiers.
|
||||
|
||||
[More on our design](docs/design.md)
|
||||
[More on our code structure](docs/code structure.md)
|
||||
|
||||
# Acknowledgements
|
||||
|
||||
# Licence
|
||||
|
||||
This project is released under MIT Licence. Please review [License file](LICENSE) for more details.
|
Двоичный файл не отображается.
После Ширина: | Высота: | Размер: 110 KiB |
Двоичный файл не отображается.
После Ширина: | Высота: | Размер: 362 KiB |
Двоичный файл не отображается.
После Ширина: | Высота: | Размер: 534 KiB |
Двоичный файл не отображается.
После Ширина: | Высота: | Размер: 2.7 MiB |
Загрузка…
Ссылка в новой задаче