This repository includes the commonocean_io python package for representing benchmarks for marine motion planning. In addition, we provide two tutorials to exemplify the usage. For an extensive scenario documentation, consider reading the [documentation for the XML format](https://gitlab.lrz.de/tum-cps/commonocean-io/-/blob/main/documentation/XML_commonOcean.pdf).
The structure of the repository is:
```
.
├── documentation # Documentation of scenario specification
└── commonocean # Source files
├── common # Folders which represent the package structure
├── ... # ...
└── doc # ´Read the Docs´ documentation for the commonocean-io package
```
## Installation instructions
Create a new Anaconda environment for Python 3.8 (here called co38).
Run in your Terminal window:
```bash
conda create −n co38 python=3.8
```
Activate your environment
```bash
conda activate co38
```
Install the package by simply using pip and, if you want to use the jupyter notebook, also install jupyter
```bash
pip install commonocean-io
pip install jupyter
```
Now everything is installed and you can start jupyter notebook to run the [tutorials](https://gitlab.lrz.de/tum-cps/commonocean-io/-/tree/main/commonocean/tutorials)
```
$ jupyter notebook
```
## Changelog
Compared to version 2022.2, the following features have been added or changed:
### Added
- New obstacle type "Waters Boundary" due to requirement in [CommonOcean DC](https://commonocean.cps.cit.tum.de/commonocean-dc)
### Fixed
- Creation of static obstacles for traffic signs such that no dublicate obstacles are created
### Changed
- Restructured State class so that it is now based on the commonroad-io state class and definition of State classes for different vessel dynamics.
- Removed duplicate classes and functions from commonroad-io to reduce maintance effort
- The packages is no longer compatible with Python 3.7
- Updated documentation
# Contibutors and Reference
We thank all the contibutors for helping develop this project (see contributors.txt).
**If you use our converter for research, please consider citing our paper:**
```
@inproceedings{Krasowski2022a,
author = {Krasowski, Hanna and Althoff, Matthias},
title = {CommonOcean: Composable Benchmarks for Motion Planning on Oceans},
booktitle = {Proc. of the IEEE International Conference on Intelligent Transportation Systems},
year = {2022},
}
```
Raw data
{
"_id": null,
"home_page": "",
"name": "commonocean-io",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "autonomous automated vessels motion planning",
"author": "Cyber-Physical Systems Group, Technical University of Munich",
"author_email": "commonocean@lists.lrz.de",
"download_url": "https://files.pythonhosted.org/packages/be/80/d642c35a5e03825f97e5e3241beb8b93d07be267a82cfa0abfe99bd1dc75/commonocean-io-2023.1.tar.gz",
"platform": null,
"description": "\n\nThis repository includes the commonocean_io python package for representing benchmarks for marine motion planning. In addition, we provide two tutorials to exemplify the usage. For an extensive scenario documentation, consider reading the [documentation for the XML format](https://gitlab.lrz.de/tum-cps/commonocean-io/-/blob/main/documentation/XML_commonOcean.pdf).\n\u200b\nThe structure of the repository is:\n\u200b\n```\n.\n\u251c\u2500\u2500 documentation # Documentation of scenario specification\n\u2514\u2500\u2500 commonocean # Source files\n \u251c\u2500\u2500 common # Folders which represent the package structure\n \u251c\u2500\u2500 ... # ...\n \u2514\u2500\u2500 doc # \u00b4Read the Docs\u00b4 documentation for the commonocean-io package\n```\n\u200b\n## Installation instructions\n\u200b\nCreate a new Anaconda environment for Python 3.8 (here called co38). \n\u200b\nRun in your Terminal window:\n```bash\nconda create \u2212n co38 python=3.8\n```\nActivate your environment\n```bash\nconda activate co38\n```\nInstall the package by simply using pip and, if you want to use the jupyter notebook, also install jupyter\n```bash\npip install commonocean-io\npip install jupyter\n```\nNow everything is installed and you can start jupyter notebook to run the [tutorials](https://gitlab.lrz.de/tum-cps/commonocean-io/-/tree/main/commonocean/tutorials)\n```\n$ jupyter notebook\n```\n\n## Changelog\n\nCompared to version 2022.2, the following features have been added or changed:\n\n### Added\n\n- New obstacle type \"Waters Boundary\" due to requirement in [CommonOcean DC](https://commonocean.cps.cit.tum.de/commonocean-dc)\n\n### Fixed\n\n- Creation of static obstacles for traffic signs such that no dublicate obstacles are created\n\n### Changed\n\n- Restructured State class so that it is now based on the commonroad-io state class and definition of State classes for different vessel dynamics.\n- Removed duplicate classes and functions from commonroad-io to reduce maintance effort \n- The packages is no longer compatible with Python 3.7\n- Updated documentation \n\n# Contibutors and Reference\n\u200b\nWe thank all the contibutors for helping develop this project (see contributors.txt).\n\u200b\n**If you use our converter for research, please consider citing our paper:**\n```\n@inproceedings{Krasowski2022a,\n\tauthor = {Krasowski, Hanna and Althoff, Matthias},\n\ttitle = {CommonOcean: Composable Benchmarks for Motion Planning on Oceans},\n\tbooktitle = {Proc. of the IEEE International Conference on Intelligent Transportation Systems},\n\tyear = {2022},\n}\n```\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Python tool to read, write, and visualize CommonOcean scenarios and solutions for automated vessels.",
"version": "2023.1",
"project_urls": null,
"split_keywords": [
"autonomous",
"automated",
"vessels",
"motion",
"planning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dea2ba1a8cbd2b6fac4037a57c4175a7275daedd6e54003781d851e27f76fa51",
"md5": "db4b192a310b91749bc898648b0710ec",
"sha256": "c0c3bc10fa3393148b671dfb0017d2824a47af4dffdbab3667230e4046674360"
},
"downloads": -1,
"filename": "commonocean_io-2023.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db4b192a310b91749bc898648b0710ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 77879,
"upload_time": "2023-09-20T21:36:23",
"upload_time_iso_8601": "2023-09-20T21:36:23.650209Z",
"url": "https://files.pythonhosted.org/packages/de/a2/ba1a8cbd2b6fac4037a57c4175a7275daedd6e54003781d851e27f76fa51/commonocean_io-2023.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be80d642c35a5e03825f97e5e3241beb8b93d07be267a82cfa0abfe99bd1dc75",
"md5": "19a7131a578ccb7ecb9784daa3e9460c",
"sha256": "8d3d85fbf5999b6c2b5433a45f2091ab8246551971a21abc4d17d2efdc684131"
},
"downloads": -1,
"filename": "commonocean-io-2023.1.tar.gz",
"has_sig": false,
"md5_digest": "19a7131a578ccb7ecb9784daa3e9460c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 68897,
"upload_time": "2023-09-20T21:36:25",
"upload_time_iso_8601": "2023-09-20T21:36:25.716220Z",
"url": "https://files.pythonhosted.org/packages/be/80/d642c35a5e03825f97e5e3241beb8b93d07be267a82cfa0abfe99bd1dc75/commonocean-io-2023.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-20 21:36:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "commonocean-io"
}
JSON