Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
yun-long committed Aug 31, 2020
1 parent bfc02b0 commit ca338ef
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 10 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2018 Robotics and Perception Group,
University of Zurich, Switzerland

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.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,16 @@

![Build Status](https://github.com/uzh-rpg/flightmare/workflows/CPP_CI/badge.svg) ![clang format](https://github.com/uzh-rpg/flightmare/workflows/clang_format/badge.svg)

We present a new modular quadrotor simulator: Flightmare.
**Flightmare** is a flexible modular quadrotor simulator.
Flightmare is composed of two main components: a configurable rendering engine built on Unity and a flexible physics engine for dynamics simulation.
Those two components are totally decoupled and can run independently from each other.
Flightmare comes with several desirable features: (i) a large multi-modal sensor suite, including an interface to extract the 3D point-cloud of the scene; (ii) an API for reinforcement learning which can simulate hundreds of quadrotors in parallel; and (iii) an integration with a virtual-reality headset for interaction with the simulated environment.
Flightmare can be used for various applications, including path-planning, reinforcement learning, visual-inertial odometry, deep learning, human-robot interaction, etc.

![flightmare](./docs/flightmare.png)
**[Website](https://uzh-rpg.github.io/flightmare/)**, **[PDF](https://uzh-rpg.github.io/flightmare/)**

# Development Progress

* flighlib
* flightros
* flightrl
* flightrender
* flightdoc
# Installation
Installation instructions can be found in our wiki.

# License
This project is released under the MIT License. Please review the [License file](LICENSE) for more details.
Binary file modified docs/flightmare.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion flightrl/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
author_email='[email protected]',
description='Flightmare: A Quadrotor Simulator.',
long_description='',
install_requires=['gym==0.10.9', 'ruamel.yaml', 'numpy', 'stable_baselines==2.8'],
install_requires=['gym==0.11', 'ruamel.yaml',
'numpy', 'stable_baselines==2.10.1'],
packages=['rpg_baselines'],
)

0 comments on commit ca338ef

Please sign in to comment.