| Name | sumocr JSON |
| Version |
2024.1
JSON |
| download |
| home_page | None |
| Summary | Python tool to interface with the SUMO traffic simulator |
| upload_time | 2024-03-27 13:35:37 |
| maintainer | None |
| docs_url | None |
| author | Florian Finkeldei |
| requires_python | <4.0,>=3.8 |
| license | BSD License |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SUMO - CommonRoad Interface
This package implements the interface between the framework for motion planning of automated vehicles [commonroad-io](https://pypi.org/project/commonroad-io/)
and the traffic simulator [SUMO](https://sumo.dlr.de).
The interface is presented in detail in our [paper](https://mediatum.ub.tum.de/doc/1486856/344641.pdf) [1].
## Documentation
Please refer to the [documentation](https://cps.pages.gitlab.lrz.de/sumo-interface/) and [tutorials](https://commonroad.in.tum.de/tools/sumo-interface).
To run interactive scenarios, denoted by the suffix ```I```, from the CommonRoad database,
please use the script from the corresponding repository [gitlab.lrz.de/tum-cps/commonroad-interactive-scenarios](https://gitlab.lrz.de/tum-cps/commonroad-interactive-scenarios).
[1] _Moritz Klischat, Octav Dragoi, Mostafa Eissa, and Matthias Althoff, Coupling SUMO with a Motion Planning Framework for Automated Vehicles, SUMO 2019: Simulating Connected Urban Mobility_
## Development
### Dependencies
You can easily install all dependencies with poetry:
```sh
$ poetry install --with tests --with dev
```
### Tests
To run the tests you can use:
```sh
$ export SUMO_HOME=$(whereis sumo)
$ poetry run pytest tests/ --ignore=./tests/sumocr/sumo_docker
```
### pre-commit
pre-commit is used to run a variety of checks on the code (e.g. formatting with `black`).
You can install the hooks with:
```sh
$ pre-commit install
```
Those hooks will be run everytime you run `git commit`.
### Documentation
The documentation is built with sphinx. Before building make sure to install the required dependencies:
```sh
$ poetry install --with docs
```
Than you can build the documentation with:
```sh
$ cd docs/source
$ poetry run sphinx-build -b html . ../../public
```
After the built finished successfully you can view in you browser by opening `public/index.html` from the root of the project.
If you perfomed API changes, you might need to recreate the API doc:
```sh
$ cd docs
$ poetry run sphinx-apidoc -o ./source/api ../sumocr
```
Raw data
{
"_id": null,
"home_page": null,
"name": "sumocr",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Florian Finkeldei",
"author_email": "florian.finkeldei@tum.de",
"download_url": "https://files.pythonhosted.org/packages/93/d9/8c3606cac59546e7a531a08dd6db827aaa8b9d03627864d87f3b99c3fe88/sumocr-2024.1.tar.gz",
"platform": null,
"description": "# SUMO - CommonRoad Interface\n\nThis package implements the interface between the framework for motion planning of automated vehicles [commonroad-io](https://pypi.org/project/commonroad-io/)\nand the traffic simulator [SUMO](https://sumo.dlr.de).\nThe interface is presented in detail in our [paper](https://mediatum.ub.tum.de/doc/1486856/344641.pdf) [1].\n\n## Documentation\n\nPlease refer to the [documentation](https://cps.pages.gitlab.lrz.de/sumo-interface/) and [tutorials](https://commonroad.in.tum.de/tools/sumo-interface).\nTo run interactive scenarios, denoted by the suffix ```I```, from the CommonRoad database,\nplease use the script from the corresponding repository [gitlab.lrz.de/tum-cps/commonroad-interactive-scenarios](https://gitlab.lrz.de/tum-cps/commonroad-interactive-scenarios).\n\n\n[1] _Moritz Klischat, Octav Dragoi, Mostafa Eissa, and Matthias Althoff, Coupling SUMO with a Motion Planning Framework for Automated Vehicles, SUMO 2019: Simulating Connected Urban Mobility_\n\n## Development\n\n### Dependencies\n\nYou can easily install all dependencies with poetry:\n\n```sh\n$ poetry install --with tests --with dev\n```\n\n### Tests\n\nTo run the tests you can use:\n\n```sh\n$ export SUMO_HOME=$(whereis sumo)\n$ poetry run pytest tests/ --ignore=./tests/sumocr/sumo_docker\n```\n\n### pre-commit\n\npre-commit is used to run a variety of checks on the code (e.g. formatting with `black`).\nYou can install the hooks with:\n\n```sh\n$ pre-commit install\n```\n\nThose hooks will be run everytime you run `git commit`.\n\n### Documentation\n\nThe documentation is built with sphinx. Before building make sure to install the required dependencies:\n\n```sh\n$ poetry install --with docs\n```\n\nThan you can build the documentation with:\n\n```sh\n$ cd docs/source\n$ poetry run sphinx-build -b html . ../../public\n```\n\nAfter the built finished successfully you can view in you browser by opening `public/index.html` from the root of the project.\nIf you perfomed API changes, you might need to recreate the API doc:\n\n```sh\n$ cd docs\n$ poetry run sphinx-apidoc -o ./source/api ../sumocr\n```\n",
"bugtrack_url": null,
"license": "BSD License",
"summary": "Python tool to interface with the SUMO traffic simulator",
"version": "2024.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10349845aedc1ac7ec9a9b17ff681688457c79d87af48534413f24efb4fdd0a6",
"md5": "a6b6fea844a7d59bb3e74d3393c134c4",
"sha256": "7d7bc53b71e89dbb0353e6a6004c138496c69391d03ed07d2d18d45664f4c23c"
},
"downloads": -1,
"filename": "sumocr-2024.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6b6fea844a7d59bb3e74d3393c134c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 65064,
"upload_time": "2024-03-27T13:35:35",
"upload_time_iso_8601": "2024-03-27T13:35:35.602029Z",
"url": "https://files.pythonhosted.org/packages/10/34/9845aedc1ac7ec9a9b17ff681688457c79d87af48534413f24efb4fdd0a6/sumocr-2024.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93d98c3606cac59546e7a531a08dd6db827aaa8b9d03627864d87f3b99c3fe88",
"md5": "608b0b931813d39a61a54d5b1a38fd99",
"sha256": "f4fac380d99f68670eafbce74752f14f6f0d5362058c9c84b8e7d7eba10800c6"
},
"downloads": -1,
"filename": "sumocr-2024.1.tar.gz",
"has_sig": false,
"md5_digest": "608b0b931813d39a61a54d5b1a38fd99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 53491,
"upload_time": "2024-03-27T13:35:37",
"upload_time_iso_8601": "2024-03-27T13:35:37.318149Z",
"url": "https://files.pythonhosted.org/packages/93/d9/8c3606cac59546e7a531a08dd6db827aaa8b9d03627864d87f3b99c3fe88/sumocr-2024.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 13:35:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sumocr"
}
