CoBRA I/O
=========
CoBRA I/O is an interface to the **C**\ omposable **B**\ enchmark for **R**\ obotics **A**\ pplications `(CoBRA) <https://cobra.cps.cit.tum.de>`_.
With it you can easily upload, download, and interact with CoBRA's robots, tasks and solutions.
.. image:: https://gitlab.lrz.de/tum-cps/cobra-io/badges/main/pipeline.svg
:target: https://gitlab.lrz.de/tum-cps/cobra-io/-/commits/%main
:alt: Pipeline Status
.. image:: https://readthedocs.org/projects/cobra-io/badge/?version=latest
:target: https://cobra-io.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://gitlab.lrz.de/tum-cps/cobra-io/badges/main/coverage.svg
:target: https://gitlab.lrz.de/tum-cps/cobra-io/-/jobs/artifacts/main/file/ci/coverage/html//index.html?job=coverage&min_acceptable=80&min_good=90
:alt: Coverage Report
Installation
------------
CoBRA I/O can easily be installed via pip::
pip install cobra-io
If you want to develop CoBRA I/O, you can clone the repository and install it in editable mode and with developer dependencies::
git clone https://gitlab.lrz.de/tum-cps/cobra-io.git
cd cobra-io
pip install -e .[dev]
Usage
-----
Examples on the usage of CoBRA I/O are provided in the `tutorials <tutorials/>`_ directory and a thorough documentation is available in `doc <doc/>`_ or `online <https://cobra-io.readthedocs.io/en/latest/>`_.
The CoBRA benchmark suite elements are specified on the `documentation subpage of CoBRA <https://cobra.cps.cit.tum.de/crok-documentation/robot>`_.
The CoBRA API is documented `here <https://cobra.cps.cit.tum.de/api/>`_.
CoBRA I/O will generate a configuration file based on the provided `sample <src/cobra/utils/cobra.config.sample>`_; find the currently used with :code:`from cobra.utils.configurations import CONFIG_FILE`.
CoBRA I/O keeps a cached version of all files in CoBRA. To invalidate these caches run :code:`python -m cobra.utils.caches` and follow the instructions.
Support
-------
For software support please use the `issue tracker <https://gitlab.lrz.de/tum-cps/cobra-io/-/issues>`_.
If you have questions with regard to the CoBRA benchmark use the `CoBRA Website <https://cobra.cps.cit.tum.de>`_.
Contributing
------------
Contributions to CoBRA I/O are always welcome.
Source code contributions are made via `merge requests <https://gitlab.lrz.de/tum-cps/cobra-io/-/merge_requests>`_.
Contributions to the benchmark suite are handled via the `CoBRA Website <https://cobra.cps.cit.tum.de>`_.
Please use the provided commit hooks to ensure a consistent code style by installing them :code:`pre-commit install`.
For more details, please refer to our `contribution guidelines <CONTRIBUTING.md>`_.
Authors and acknowledgment
--------------------------
CoBRA I/O is developed at the chair of robotics, artificial intelligence and embedded systems at TU Munich.
It is designed, developed and maintained by Matthias Mayer, Jonathan Külz, and Matthias Althoff.
The developers gratefully acknowledge financial support by the Horizon 2020 EU Framework Project `CONCERT <https://concertproject.eu/>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "cobra-io",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Modular Reconfigurable Robots, Robot Design, Model Generation, Simulation, Benchmark, Path Planning",
"author": null,
"author_email": "Matthias Mayer <matthias.mayer@tum.de>",
"download_url": null,
"platform": null,
"description": "CoBRA I/O\n=========\n\nCoBRA I/O is an interface to the **C**\\ omposable **B**\\ enchmark for **R**\\ obotics **A**\\ pplications `(CoBRA) <https://cobra.cps.cit.tum.de>`_.\nWith it you can easily upload, download, and interact with CoBRA's robots, tasks and solutions.\n\n.. image:: https://gitlab.lrz.de/tum-cps/cobra-io/badges/main/pipeline.svg\n :target: https://gitlab.lrz.de/tum-cps/cobra-io/-/commits/%main\n :alt: Pipeline Status\n\n.. image:: https://readthedocs.org/projects/cobra-io/badge/?version=latest\n :target: https://cobra-io.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://gitlab.lrz.de/tum-cps/cobra-io/badges/main/coverage.svg\n :target: https://gitlab.lrz.de/tum-cps/cobra-io/-/jobs/artifacts/main/file/ci/coverage/html//index.html?job=coverage&min_acceptable=80&min_good=90\n :alt: Coverage Report\n\n\nInstallation\n------------\n\nCoBRA I/O can easily be installed via pip::\n\n pip install cobra-io\n\nIf you want to develop CoBRA I/O, you can clone the repository and install it in editable mode and with developer dependencies::\n\n git clone https://gitlab.lrz.de/tum-cps/cobra-io.git\n cd cobra-io\n pip install -e .[dev]\n\nUsage\n-----\n\nExamples on the usage of CoBRA I/O are provided in the `tutorials <tutorials/>`_ directory and a thorough documentation is available in `doc <doc/>`_ or `online <https://cobra-io.readthedocs.io/en/latest/>`_.\nThe CoBRA benchmark suite elements are specified on the `documentation subpage of CoBRA <https://cobra.cps.cit.tum.de/crok-documentation/robot>`_.\nThe CoBRA API is documented `here <https://cobra.cps.cit.tum.de/api/>`_.\nCoBRA I/O will generate a configuration file based on the provided `sample <src/cobra/utils/cobra.config.sample>`_; find the currently used with :code:`from cobra.utils.configurations import CONFIG_FILE`.\n\nCoBRA I/O keeps a cached version of all files in CoBRA. To invalidate these caches run :code:`python -m cobra.utils.caches` and follow the instructions.\n\nSupport\n-------\n\nFor software support please use the `issue tracker <https://gitlab.lrz.de/tum-cps/cobra-io/-/issues>`_.\nIf you have questions with regard to the CoBRA benchmark use the `CoBRA Website <https://cobra.cps.cit.tum.de>`_.\n\nContributing\n------------\n\nContributions to CoBRA I/O are always welcome.\nSource code contributions are made via `merge requests <https://gitlab.lrz.de/tum-cps/cobra-io/-/merge_requests>`_.\nContributions to the benchmark suite are handled via the `CoBRA Website <https://cobra.cps.cit.tum.de>`_.\nPlease use the provided commit hooks to ensure a consistent code style by installing them :code:`pre-commit install`.\nFor more details, please refer to our `contribution guidelines <CONTRIBUTING.md>`_.\n\nAuthors and acknowledgment\n--------------------------\nCoBRA I/O is developed at the chair of robotics, artificial intelligence and embedded systems at TU Munich.\nIt is designed, developed and maintained by Matthias Mayer, Jonathan K\u00fclz, and Matthias Althoff.\n\nThe developers gratefully acknowledge financial support by the Horizon 2020 EU Framework Project `CONCERT <https://concertproject.eu/>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Composable Benchmark for Robotics Applications - Input/Output",
"version": "0.0.4",
"project_urls": {
"Bug Tracker": "https://gitlab.lrz.de/tum-cps/cobra-io/-/issues",
"Documentation": "https://cobra-io.readthedocs.io/en/latest/",
"Source Code": "https://gitlab.lrz.de/tum-cps/cobra-io"
},
"split_keywords": [
"modular reconfigurable robots",
" robot design",
" model generation",
" simulation",
" benchmark",
" path planning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "670dc691a8c9dc4de5bd5ff16ac2fb5c15d563025f9b6bd1c5eba8aab3598be7",
"md5": "6087abf38f7899d2c439e578279577af",
"sha256": "960e3bc44fe33fcce7f2c1a504947ffa2d648cf82d098041fd5f66fd656b4864"
},
"downloads": -1,
"filename": "cobra_io-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6087abf38f7899d2c439e578279577af",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18276,
"upload_time": "2024-04-15T13:52:52",
"upload_time_iso_8601": "2024-04-15T13:52:52.967690Z",
"url": "https://files.pythonhosted.org/packages/67/0d/c691a8c9dc4de5bd5ff16ac2fb5c15d563025f9b6bd1c5eba8aab3598be7/cobra_io-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 13:52:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cobra-io"
}
JSON