.. ros_typedb documentation master file, created by
   sphinx-quickstart on Fri Oct 13 14:09:15 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ros_typedb's documentation!
======================================

ros_typedb provides a basic generic integration between ROS and `typeDB <https://typedb.com/>`_.
It was designed in a way to enable users to easily extend it to fulfill their
needs, its design is explained in the :doc:`design` section.

This package was tested in Ubuntu 22.04 with ROS Humble and typedb v2.24.17.

**ros_typedb is in an initial stage and under constant development**

.. toctree::
  Home <self>
  design
  installation
  usage
  api
  :maxdepth: 1


Contribute
----------

- Issue Tracker: https://github.com/kas-lab/ros_typedb/issues
- Source Code: https://github.com/kas-lab/ros_typedb/

Support
-------

If you are having issues, please let us know by creating an issue in github.

License
-------

The project is licensed under the Apache 2.0 license

Acknowledgments
----------------
.. raw:: html

  <embed>
    <a href="https://remaro.eu/">
        <img height="60" alt="REMARO Logo" src="https://remaro.eu/wp-content/uploads/2020/09/remaro1-right-1024.png">
    </a>
  </embed>

This work is part of the Reliable AI for Marine Robotics (REMARO) Project. For more info, please visit: https://remaro.eu/

.. raw:: html

  <embed>
    <a href="https://research-and-innovation.ec.europa.eu/funding/funding-opportunities/funding-programmes-and-open-calls/horizon-2020_en">
        <img align="left" height="60" alt="EU Flag" src="https://remaro.eu/wp-content/uploads/2020/09/flag_yellow_low.jpg">
    </a>
  </embed>

This project has received funding from the European Union's Horizon 2020 research and innovation programme under the Marie Skłodowska-Curie grant agreement No. 956200.