diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..65be5aee15 --- /dev/null +++ b/LICENSE @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index 53d8c9c0fd..692991e7e1 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file diff --git a/docs/flightmare.png b/docs/flightmare.png index 1d8b094feb..5cf858d73a 100644 Binary files a/docs/flightmare.png and b/docs/flightmare.png differ diff --git a/flightrl/setup.py b/flightrl/setup.py index d26513cf95..e7cd786ea2 100644 --- a/flightrl/setup.py +++ b/flightrl/setup.py @@ -15,6 +15,7 @@ author_email='song@ifi.uzh.ch', 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'], )