Added pyrate as a direct dependency.
This commit is contained in:
30
pyrate/doc/source/index.rst
Normal file
30
pyrate/doc/source/index.rst
Normal file
@ -0,0 +1,30 @@
|
||||
Welcome to Pyrate!
|
||||
==================
|
||||
|
||||
This project offers algorithms targeted towards autonomous surface vehicles implemented in the Python 3.6+ programming language.
|
||||
The functionality included in the Pyrate Python package enables the perception and processing of environmental features, planning of strategies and trajectories as well as action taking.
|
||||
Pyrate is therefore divided into multiple distinct subpackages *sense*, *plan* and *act*, as well as the *common* package for additional features such as file I/O and mathematical abstractions.
|
||||
|
||||
The sense subpackage includes algorithms for computer vision, single and multi target state estimation, data smoothing and more.
|
||||
In the plan subpackage, the perceived state of the agent and its environment is processed to compute trajectories for long- and short-term navigation as well as strategic decisions.
|
||||
This also includes methods for gradient based and gradient free optimization methods are included.
|
||||
Finally, the act subpackage contains state controllers to carry out planned behavior.
|
||||
|
||||
.. image:: ../../resources/project_structure.png
|
||||
|
||||
This project aims at providing the algorithmic backend for the ROS driven on-board systems and simulations.
|
||||
Models of the robot's mechanics, electronics and its environment shall be developed within their own respective repository.
|
||||
Furthermore technical specifications, maps and so on go into a separate project repository as well.
|
||||
This ensures a clean separation of distinct requirements for quality assurance and responsibilities that distinguish these projects.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
installation
|
||||
sense/sense
|
||||
plan/plan
|
||||
act/act
|
||||
common/common
|
||||
scripts/scripts
|
||||
contribution
|
||||
quality_assurance
|
Reference in New Issue
Block a user