# commonocean-io
The CommonOcean Input-Output package provides methods for reading, writing, and visualizing CommonOcean scenarios and planning problems. It can also be used as a framework for implementing motion planning algorithms to solve CommonOcean benchmarks and is the basis for other tools in the CommonOcean framework. Learn more about the scenario specification [here](https://gitlab.lrz.de/tum-cps/commonocean-io/-/blob/main/documentation/XML_commonOcean.pdf).
## Documentation
The full documentation of the API can be found [here](https://commonocean-documentation.readthedocs.io/en/latest/).
For getting started, we recommend our [tutorials](https://commonocean.cps.cit.tum.de/getting-started).
## Requirements
The required dependencies for running commonocean-io are:
* commonocean-vessel-models==1.0.0
* commonroad-io==2023.1
* matplotlib~=3.5.0
* numpy~=1.22.4
* imageio~=2.9.0
* setuptools>=42.0.1
* lxml>=4.2.2
* iso3166>=1.0.1
* pytest>=7.1.1
## Installation
Create a new Anaconda environment for Python 3.8 (here called co38):
```bash
conda create -n co38 python=3.8
conda activate co38
```
Install the package using pip and, if you want to use the jupyter notebook, install jupyter as well:
```bash
pip install commonocean-io
pip install jupyter
```
Start jupyter notebook to run the [tutorials](https://gitlab.lrz.de/tum-cps/commonocean-io/-/tree/main/commonocean/tutorials):
```bash
jupyter notebook
```
## Changelog
Compared to version 2023.1, the following features have been added or changed:
### Added
- New rendering functionality with MPRenderer
### Fixed
- Consistent writing and reading or vessel states
- Formatting errors in XML blueprint file
### Changed
- Improved State classes so that more specific state classes are used. Introduction of InputState classes.
- Updated dependencies
- Updated documentation and tutorials
# Contibutors
We thank all contributors for their help in developing this project (see contributors.txt).
# Citation
**If you use our code 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": null,
"name": "commonocean-io",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "autonomous 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/90/d7/530cf7ae6e221e9837810968363ce91358d1fc62fbfa346f0d16be762a86/commonocean_io-2025.1.tar.gz",
"platform": null,
"description": "\n\n# commonocean-io\n\nThe CommonOcean Input-Output package provides methods for reading, writing, and visualizing CommonOcean scenarios and planning problems. It can also be used as a framework for implementing motion planning algorithms to solve CommonOcean benchmarks and is the basis for other tools in the CommonOcean framework. Learn more about the scenario specification [here](https://gitlab.lrz.de/tum-cps/commonocean-io/-/blob/main/documentation/XML_commonOcean.pdf).\n\n\u200b\n## Documentation\n\nThe full documentation of the API can be found [here](https://commonocean-documentation.readthedocs.io/en/latest/).\n\nFor getting started, we recommend our [tutorials](https://commonocean.cps.cit.tum.de/getting-started).\n\n## Requirements\n\nThe required dependencies for running commonocean-io are:\n\n* commonocean-vessel-models==1.0.0\n* commonroad-io==2023.1\n* matplotlib~=3.5.0\n* numpy~=1.22.4\n* imageio~=2.9.0\n* setuptools>=42.0.1\n* lxml>=4.2.2\n* iso3166>=1.0.1\n* pytest>=7.1.1\n\n## Installation\n\u200b\nCreate a new Anaconda environment for Python 3.8 (here called co38):\n\n```bash\nconda create -n co38 python=3.8\nconda activate co38\n```\nInstall the package using pip and, if you want to use the jupyter notebook, install jupyter as well:\n```bash\npip install commonocean-io\npip install jupyter\n```\nStart jupyter notebook to run the [tutorials](https://gitlab.lrz.de/tum-cps/commonocean-io/-/tree/main/commonocean/tutorials):\n\n```bash\njupyter notebook\n```\n\n## Changelog\n\nCompared to version 2023.1, the following features have been added or changed:\n\n### Added\n\n- New rendering functionality with MPRenderer\n\n### Fixed\n\n- Consistent writing and reading or vessel states\n- Formatting errors in XML blueprint file \n\n### Changed\n\n- Improved State classes so that more specific state classes are used. Introduction of InputState classes.\n- Updated dependencies \n- Updated documentation and tutorials\n\n\n# Contibutors\n\u200b\nWe thank all contributors for their help in developing this project (see contributors.txt).\n\n# Citation\n\u200b\n**If you use our code 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": "2025.1",
"project_urls": null,
"split_keywords": [
"autonomous",
"vessels",
"motion",
"planning"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eb8ab48b6647d87b864388d192c7fbd24d60f5928d11178619430ad1799a7d49",
"md5": "3a4b4085b005938e3022f3ab58491f1d",
"sha256": "65ed3c19ced2c586b28c9250918482d50e14d31c77d9dfe7e7e775366f6a1832"
},
"downloads": -1,
"filename": "commonocean_io-2025.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a4b4085b005938e3022f3ab58491f1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 105156,
"upload_time": "2025-07-12T22:48:09",
"upload_time_iso_8601": "2025-07-12T22:48:09.623168Z",
"url": "https://files.pythonhosted.org/packages/eb/8a/b48b6647d87b864388d192c7fbd24d60f5928d11178619430ad1799a7d49/commonocean_io-2025.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "90d7530cf7ae6e221e9837810968363ce91358d1fc62fbfa346f0d16be762a86",
"md5": "565a23b4483d43c305c5ec33036f9561",
"sha256": "0ff4921654ade490a8a4a8d83e690f8dbf541df2f1414acbedf6a90666e3b194"
},
"downloads": -1,
"filename": "commonocean_io-2025.1.tar.gz",
"has_sig": false,
"md5_digest": "565a23b4483d43c305c5ec33036f9561",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 91532,
"upload_time": "2025-07-12T22:48:10",
"upload_time_iso_8601": "2025-07-12T22:48:10.738659Z",
"url": "https://files.pythonhosted.org/packages/90/d7/530cf7ae6e221e9837810968363ce91358d1fc62fbfa346f0d16be762a86/commonocean_io-2025.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 22:48:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "commonocean-io"
}
JSON