| Name | opendrive-bssd-converter JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | integrate_BSSD_into_OpenDRIVE reads in an OpenDRIVE-file and integrates a BSSD-structure into this OpenDRIVE-file |
| upload_time | 2024-08-01 11:56:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright 2024 Institute of Automotive Engineering (FZD), Technical University of Darmstadt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
bssd
lanelet2
osm
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OpenDRIVE_BSSD_Converter
Tool for integrating BSSD-data into an existing OpenDRIVE-file (.xodr) with Version 1.4, 1.5, 1.6 or 1.7.
<p align="center">
<img src="doc/screenshot_overview.jpg" width="500">
</p>
## Requirements
- Python (Tool has been tested with Python 3.7, 3.8 and 3.9)
- The following Python-modules are needed:
- easygui==0.98.1
- lxml==4.6.3
- pandas==1.3.4
- rich==10.16.2
- scipy==1.7.1
- tqdm==4.62.3
- importlib_resources
The tool has been tested with the versions of the modules specified in the list above. It may also work with other module-versions, but the correct functionality can't be guaranteed in this case.
**Hint**: Some parts of the visualiziation of the tool in the terminal are based on the python package [rich](https://rich.readthedocs.io/en/stable/introduction.html). In some terminals on Windows the full visualization of *rich* does not work properly (e.g. *PowerShell*, *cmd*). Nevertheless, everything will be displayed so that the correct functionality is guaranteed.
In Windows for a full visualiziation with *rich*, the use of the [Windows-Terminal](https://www.microsoft.com/de-de/p/windows-terminal/9n0dx20hk701) is recommended. In macOS (*Terminal*) and Linux (*Terminal*) the full visualization should work properly.
## Installation
### Using pip
```bash
pip install opendrive-bssd-converter
```
This will install the latest version of the OpenDRIVE-BSSD-Converter available in [PyPI](https://pypi.org/project/bssd/) to your environment.
### Manual Installation
1. Clone the Repository (with HTTPS or SSH)
a. HTTPS:
`git clone https://gitlab.com/tuda-fzd/scenery-representations-and-maps/opendrive-bssd-converter.git`
or
b. SSH:
`git clone git@gitlab.com:tuda-fzd/scenery-representations-and-maps/opendrive-bssd-converter.git`
2. (Create & activate a virtual environment if you want to install the tool inside a virtual environment)
3. Open a terminal window in the folder `opendrive_bssd_converter` and install the required packages as well as the tool itself with the command
`pip install -e .`
## Usage
1. Start the tool: Run
```bash
opendrive-bssd-converter
```
2. If the tool started successfully, you can choose your OpenDRIVE-file in the window, which opens immediately after executing.
3. You will be able to modify the behaviour of the tool thoughout the process, therefore watch the terminal for prompts and provide your input.
4. After successfully executing the tool, the modified OpenDRIVE-file will be stored in the same folder as the original OpenDRIVE-file with the same name plus the suffix "_BSSD".
Raw data
{
"_id": null,
"home_page": null,
"name": "opendrive-bssd-converter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bssd, lanelet2, osm",
"author": null,
"author_email": "Moritz Bergh\u00f6fer <moritz.berghoefer@web.de>",
"download_url": "https://files.pythonhosted.org/packages/ca/c3/08ee4ab3c354f2c07e4127f87805a4d545e3e7a94e915ba935b87cd0b03b/opendrive_bssd_converter-0.1.0.tar.gz",
"platform": null,
"description": "\ufeff# OpenDRIVE_BSSD_Converter\n\nTool for integrating BSSD-data into an existing OpenDRIVE-file (.xodr) with Version 1.4, 1.5, 1.6 or 1.7.\n\n<p align=\"center\">\n <img src=\"doc/screenshot_overview.jpg\" width=\"500\">\n</p>\n\n\n## Requirements\n\n - Python (Tool has been tested with Python 3.7, 3.8 and 3.9)\n - The following Python-modules are needed:\n\t - easygui==0.98.1\n\t - lxml==4.6.3\n\t - pandas==1.3.4\n\t - rich==10.16.2\n\t - scipy==1.7.1\n\t - tqdm==4.62.3\n - importlib_resources\n\nThe tool has been tested with the versions of the modules specified in the list above. It may also work with other module-versions, but the correct functionality can't be guaranteed in this case.\n\n**Hint**: Some parts of the visualiziation of the tool in the terminal are based on the python package [rich](https://rich.readthedocs.io/en/stable/introduction.html). In some terminals on Windows the full visualization of *rich* does not work properly (e.g. *PowerShell*, *cmd*). Nevertheless, everything will be displayed so that the correct functionality is guaranteed.\n\nIn Windows for a full visualiziation with *rich*, the use of the [Windows-Terminal](https://www.microsoft.com/de-de/p/windows-terminal/9n0dx20hk701) is recommended. In macOS (*Terminal*) and Linux (*Terminal*) the full visualization should work properly.\n\n\n## Installation\n### Using pip\n```bash\npip install opendrive-bssd-converter\n```\nThis will install the latest version of the OpenDRIVE-BSSD-Converter available in [PyPI](https://pypi.org/project/bssd/) to your environment.\n\n### Manual Installation\n\n1. Clone the Repository (with HTTPS or SSH)\n\n\ta. HTTPS:\n\n\t`git clone https://gitlab.com/tuda-fzd/scenery-representations-and-maps/opendrive-bssd-converter.git`\n\n\tor\n\n\tb. SSH:\n\n\t`git clone git@gitlab.com:tuda-fzd/scenery-representations-and-maps/opendrive-bssd-converter.git`\n2. (Create & activate a virtual environment if you want to install the tool inside a virtual environment)\n3. Open a terminal window in the folder `opendrive_bssd_converter` and install the required packages as well as the tool itself with the command\n\n `pip install -e .`\n\n## Usage\n1. Start the tool: Run\n```bash\nopendrive-bssd-converter\n```\n2. If the tool started successfully, you can choose your OpenDRIVE-file in the window, which opens immediately after executing.\n3. You will be able to modify the behaviour of the tool thoughout the process, therefore watch the terminal for prompts and provide your input.\n4. After successfully executing the tool, the modified OpenDRIVE-file will be stored in the same folder as the original OpenDRIVE-file with the same name plus the suffix \"_BSSD\".\n",
"bugtrack_url": null,
"license": "Copyright 2024 Institute of Automotive Engineering (FZD), Technical University of Darmstadt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "integrate_BSSD_into_OpenDRIVE reads in an OpenDRIVE-file and integrates a BSSD-structure into this OpenDRIVE-file",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"bssd",
" lanelet2",
" osm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "899e4e83aaf4171a6ebf24d3fb2307249be62047d736e04da7287a17755e61d6",
"md5": "e0ee60bef2e8752ed654803a243ec9dd",
"sha256": "009817951cbe739d20ff3cdbc47426517c393f622f4a3d72c0917c3e18f505a6"
},
"downloads": -1,
"filename": "opendrive_bssd_converter-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0ee60bef2e8752ed654803a243ec9dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 183908,
"upload_time": "2024-08-01T11:56:05",
"upload_time_iso_8601": "2024-08-01T11:56:05.681654Z",
"url": "https://files.pythonhosted.org/packages/89/9e/4e83aaf4171a6ebf24d3fb2307249be62047d736e04da7287a17755e61d6/opendrive_bssd_converter-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cac308ee4ab3c354f2c07e4127f87805a4d545e3e7a94e915ba935b87cd0b03b",
"md5": "d7a67aa557f1c8550f6e14840bb8d434",
"sha256": "0fc133f55d25bae82074d463c5c3010bdae168156d8616f63794eaf6cca144a4"
},
"downloads": -1,
"filename": "opendrive_bssd_converter-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d7a67aa557f1c8550f6e14840bb8d434",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 180376,
"upload_time": "2024-08-01T11:56:07",
"upload_time_iso_8601": "2024-08-01T11:56:07.426206Z",
"url": "https://files.pythonhosted.org/packages/ca/c3/08ee4ab3c354f2c07e4127f87805a4d545e3e7a94e915ba935b87cd0b03b/opendrive_bssd_converter-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-01 11:56:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "opendrive-bssd-converter"
}
