Skip to content

Commit

Permalink
add refs to paper
Browse files Browse the repository at this point in the history
  • Loading branch information
jlblancoc committed Feb 25, 2023
1 parent 4192272 commit 9bc8f83
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 4 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,25 @@ MultiVehicle simulator (MVSIM)
Lightweight, realistic dynamical simulator for 2D ("2.5D") vehicles and robots.
It is tailored to analysis of vehicle dynamics, wheel-ground contact forces and accurate simulation of typical robot sensors (e.g. 2D and 3D lidars).

This package includes C++ libraries, standalone applications, and ROS-1 and ROS-2 nodes.
This package includes C++ libraries, standalone applications, and ROS 1 and ROS 2 nodes.

License: 3-clause BSD License
Copyright (C) 2014-2023 Jose Luis Blanco <[email protected]> (University of Almeria) and collaborators

Please, refer to [the MVSim paper](https://arxiv.org/abs/2302.11033) for a gentle introduction
to the project architecture.
If you want to cite MVSim in your work, please use:

@misc{mvsim,
doi = {10.48550/ARXIV.2302.11033},
url = {https://arxiv.org/abs/2302.11033},
author = {Blanco-Claraco, José-Luis and Tymchenko, Borys and Mañas-Alvarez, Francisco José and Cañadas-Aránega, Fernando and López-Gázquez, Ángel and Moreno, José Carlos},
title = {MultiVehicle Simulator (MVSim): lightweight dynamics simulator for multiagents and mobile robotics research},
publisher = {arXiv},
year = {2023}
}


![screenshot-demo](docs/imgs/mvsim-ros2-demo.gif)

[![MvSim intro](https://img.youtube.com/vi/xMUMjEG8xlk/0.jpg)](https://www.youtube.com/watch?v=xMUMjEG8xlk)
Expand Down
10 changes: 7 additions & 3 deletions docs/architecture.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
Architecture
=================================

Please, refer to `the MVSim paper <https://arxiv.org/abs/2302.11033>`_
for a gentle introduction to the project architecture.

The project comprises:

- A C++ library: ``libmvsim``
- A ROS1 node. It can be run standalone.
- ``mvsim-server``: A standalone program to run the simulation and, optionally,
- C++ libraries: ``libmvsim-comms``, ``libmvsim-comms``, ``libmvsim-comms``,
- A ROS 1 and ROS 2 node (both in the same git branch).
- Python3 wrappers.
- ``mvsim-cli``: A standalone program to run the simulation and, optionally,
displaying a GUI live view of the world, accept keyboard/mouse orders, etc.
It also uses ZMQ+protobuf as a communication system for user programs to
interact with the simulation (for example, from a C++ or Python program).
Expand Down
14 changes: 14 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ This project includes a C++ library `mvsim`, a standalone app, and a ROS1 node.

Licensed under the permissive 3-clause BSD License.

If you want to cite MVSim in your work, please use:

.. code-block:: bibtex
@misc{mvsim,
doi = {10.48550/ARXIV.2302.11033},
url = {https://arxiv.org/abs/2302.11033},
author = {Blanco-Claraco, José-Luis and Tymchenko, Borys and Mañas-Alvarez, Francisco José and Cañadas-Aránega, Fernando and López-Gázquez, Ángel and Moreno, José Carlos},
title = {MultiVehicle Simulator (MVSim): lightweight dynamics simulator for multiagents and mobile robotics research},
publisher = {arXiv},
year = {2023}
}
.. figure:: https://mrpt.github.io/mvsim-models/anims/warehouse-demo-mvsim.gif
:alt: MVSIM Simulating Jackal Robot in ROS2
:target: first-steps.html
Expand Down

0 comments on commit 9bc8f83

Please sign in to comment.