-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Start writing README + license [ci skip]
- Loading branch information
1 parent
1c596c6
commit 3703cd5
Showing
3 changed files
with
53 additions
and
11 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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
BSD 2-Clause License | ||
|
||
Copyright (c) 2022-2024 Computational Intelligence Lab, University of Patras, Greece | ||
Copyright (c) 2023-2024 Laboratory of Automation and Robotics, University of Patras, Greece | ||
Copyright (c) 2017-2018 LARSEN Team, Inria, France | ||
Copyright (c) 2017-2024 Konstantinos Chatzilygeroudis | ||
Copyright (c) 2017-2024 Jean-Baptiste Mouret | ||
Copyright (c) 2023-2024 Dionis Totsila | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, this | ||
list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
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 |
---|---|---|
@@ -1,23 +1,35 @@ | ||
robot_dart [](https://github.com/resibots/robot_dart/actions/workflows/ci_linux.yml) | ||
RobotDART [](https://github.com/resibots/robot_dart/actions/workflows/ci_linux.yml) | ||
===================================================================================================================================================================================================== | ||
|
||
### CAUTION: The library is under-going a serious re-structure and development. Expect breaking of API/ABI, and out-of-date guides. We will soon provide a new release with many new features and a proper documentation. | ||
RobotDART is a C++ robot simulator (with optional Python bindings) built on top of the [DART] physics engine. The RobotDART simulator is intended to be used by Robotics and Machine Learning researchers who want to write controllers or test learning algorithms without the delays and overhead that usually comes with other simulators (e.g., Gazebo, Coppelia-sim). | ||
|
||
#### This repo contains a generic wrapper around the [DART] simulator. | ||
## Documentation | ||
|
||
Documentation is available at: [https://resibots.eu/robot_dart/](https://resibots.eu/robot_dart/) | ||
|
||
## Authors | ||
|
||
- Author/Maintainer: Konstantinos Chatzilygeroudis | ||
- Active contributors: Jean-Baptiste Mouret | ||
- Author/Maintainer: Konstantinos Chatzilygeroudis (University of Patras) | ||
- Active contributors: Dionis Totsila (Inria and University of Patras), Jean-Baptiste Mouret (Inria) | ||
- Other contributors: Antoine Cully, Vassilis Vassiliades, Vaios Papaspyros | ||
|
||
### Using the code | ||
## Acknowledgments | ||
|
||
This work was partly supported by the [Hellenic Foundation for Research and Innovation](https://www.elidek.gr/en/homepage/) (H.F.R.I.) under the "3rd Call for H.F.R.I. Research Projects to support Post-Doctoral Researchers" (Project Acronym: [NOSALRO](), Project Number: 7541). | ||
|
||
<p align="center"> | ||
<img src="https://www.elidek.gr/wp-content/themes/elidek/images/elidek_logo_en.png" alt="logo_elidek"/> | ||
<p/> | ||
|
||
This work was partly supported by the ResiBots ERC Project (http://www.resibots.eu). | ||
|
||
<p aling="center"> | ||
<img src="http://resibots.eu/_static/resibots_logo_black_200px.png" alt="logo_resibots"/> | ||
</p> | ||
|
||
Please look at the [installation guide](docs/installation.md). You will find detailed guidelines on how to properly install all the dependencies, compile the code and run the examples. There is also a short [tutorial](docs/tutorial.md) where the basics of this small library are explained through coding a small example. Moreover, a small [guide](docs/guide.md) provides a brief overview of the main classes and functionality of the library. Finally, there exist python bindings of the library, located [here](src/python) (see the examples for usage). | ||
|
||
## LICENSE | ||
## License | ||
|
||
[CeCILL] | ||
[BSD 2-Clause "Simplified" License](https://opensource.org/license/bsd-2-clause/) | ||
|
||
[CeCILL]: http://www.cecill.info/index.en.html | ||
[DART]: http://dartsim.github.io/ |
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