index.rst

Welcome to CyPhyHouse's documentation!

This website is the technical documentation for the CyPhyHouse project. For a non-technical overview and research papers of the CyPhyHouse project, please visit our project website at https://cyphyhouse.github.io/.

Users are expected to familiarize themselves with Robot Operating System (ROS) and Gazebo simulation environment in order to use the software stack provide in CyPhyHouse project. We recommend beginners to at least walk through the tutorials in http://wiki.ros.org/ before trying out our software.

Demo

.. todo::
    Add demo videos and mention each component

.. toctree::
    :titlesonly:
    :hidden:
    :caption: Project Links

    CyPhyHouse Website <https://cyphyhouse.github.io/>
    CyPhyHouse GitHub Organization <https://github.com/cyphyhouse>

.. toctree::
   :maxdepth: 2
   :caption: Contents

   docs/architecture
   CyPhyHouseExperiments/docs/config
   KoordLanguage/docs/index
   Cymulator/docs/index