.. perlsv2 documentation master file

perls2: Perception and Robot Learning System
============================================

Index for documentation related to perls2. perls2 is a library that connects simulators, robots, cameras, sensors and controllers for robot learning experiments. It allows for easily switching between simulated and real robot experiments, and provides access to documented and validated robot controllers in joint space and operational space.


perls2
------

.. toctree::
   :maxdepth: 1
   :caption: Introduction

   source/introduction.md
   install.md
   quickstart.md
   source/panda_setup.md

.. toctree::
   :maxdepth: 1
   :caption: Modules

   source/environments.md
   source/worlds.md
   source/robot_interfaces.md
   source/controller_eqns.ipynb


.. toctree::
   :maxdepth: 1
   :caption: Examples

   simple_reach.md
   source/load_objects.md
   source/switch_sim_real.md
   source/project_template.md

.. toctree::
   :maxdepth: 2
   :caption: API

   env.rst
   world.rst
   robot_interface.rst
   controller.rst
   object_interface.rst
   camera_interface.rst


.. toctree::
   :maxdepth: 1
   :caption: Infrastructure

.. toctree::
   :maxdepth: 1
   :caption: Real Robot Control

   source/panda_setup.md
   source/panda_nuc_setup.md
   source/panda_ws_setup.md
   source/panda_instructions.md
   source/sawyer_setup.md
   source/sawyer_nuc_setup.md
   source/sawyer_ws_setup.md
   source/sawyer_instructions.md
   source/redis.md
   source/demos.md

.. toctree::
   :maxdepth: 1
   :caption: Real Cameras

   source/real_cameras.md



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`