truckscenes-devkit


Nametruckscenes-devkit JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/TUMFTM/truckscenes-devkit
SummaryOfficial development kit of the MAN TruckScenes dataset (www.man.eu/truckscenes).
upload_time2024-08-01 17:25:09
maintainerNone
docs_urlNone
authorFelix Fent, Fabian Kuttenreich, Florian Ruch, Farija Rizwin
requires_python>=3.6
licenseApache-2.0
keywords man truckscenes dataset devkit perception
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">

<h1>MAN TruckScenes devkit</h1>

The first multimodal dataset for autonomous trucking

[![Python](https://img.shields.io/badge/python-3-blue.svg)](https://www.python.org/downloads/)
[![Linux](https://img.shields.io/badge/os-linux-blue.svg)](https://www.linux.org/)
[![Windows](https://img.shields.io/badge/os-windows-blue.svg)](https://www.microsoft.com/windows/)

</div>

## Overview
- [Installation](#installation)
- [Setup](#truckscenes-setup)
- [Usage](#truckscenes-usage)
- [Citation](#citation)

## Installation
Our devkit is available and can be installed via pip:
```
pip install truckscenes-devkit
```

If you also want to install all the (optional) dependencies for running the visualizations:
```
pip install "truckscenes-devkit[all]"
```

The usage requires Python (install [here](https://www.python.org/downloads/), tested for 3.6 and 3.8) and pip (install [here](https://pip.pypa.io/en/stable/installation/)) for the installation.

## TruckScenes Setup
The MAN TruckScenes dataset can be downloaded on our [Download page](https://www.man.eu/truckscenes/) or search for TruckScenes in the [AWS Open Data Registry](https://registry.opendata.aws/).  

For the devkit to work you will need to download **all** archives.  
Please unpack the archives to the `/data/truckscenes` folder **without** overwriting folders that occur in multiple archives.  
Eventually you should have the following folder structure:
```
/data/truckscenes
    samples	-	Sensor data for keyframes.
    sweeps	-	Sensor data for intermediate frames.
    v1.0-*	-	JSON tables that include all the meta data and annotations. Each split (trainval, test, mini) is provided in a separate folder.
```
If you want to use another folder, specify the `dataroot` parameter of the TruckScenes class (see [installation](./docs/installation.md)).

## TruckScenes Usage
Please follow these steps to make yourself familiar with the MAN TruckScenes dataset:
- [Download](https://www.man.eu/truckscenes/) the dataset on our website.
- Make yourself familiar with the [dataset schema](./docs/schema_truckscenes.md)
- Run the [tutorial](./python-sdk/tutorials/truckscenes_tutorial.ipynb) to get started:
  ```
  jupyter notebook $HOME/truckscenes-devkit/tutorials/truckscenes_tutorial.ipynb
  ```
- Read the [MAN TruckScenes Paper](https://arxiv.org/abs/2407.07462) for a detailed analysis of the dataset.

## Citation
```
@article{truckscenes2024,
  title={MAN TruckScenes: A multimodal dataset for autonomous trucking in diverse conditions},
  author={Fent, Felix and Kuttenreich, Fabian and Ruch, Florian and Rizwin, Farija and
    Juergens, Stefan and Lechermann, Lorenz and Nissler, Christian and Perl, Andrea and
    Voll, Ulrich and Yan, Min and Lienkamp, Markus},
  journal={arXiv preprint arXiv:2407.07462},
  year={2024}
}
```

_Copied and adapted from [nuscenes-devkit](https://github.com/nutonomy/nuscenes-devkit)_



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TUMFTM/truckscenes-devkit",
    "name": "truckscenes-devkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "MAN, TruckScenes, dataset, devkit, perception",
    "author": "Felix Fent, Fabian Kuttenreich, Florian Ruch, Farija Rizwin",
    "author_email": "truckscenes@man.eu",
    "download_url": "https://files.pythonhosted.org/packages/d9/fa/d5a14c39e878e4d0c630a8933e5b60872fa526fa41c6e586b68077680dd8/truckscenes-devkit-1.0.0.tar.gz",
    "platform": "linux",
    "description": "<div align=\"center\">\r\n\r\n<h1>MAN TruckScenes devkit</h1>\r\n\r\nThe first multimodal dataset for autonomous trucking\r\n\r\n[![Python](https://img.shields.io/badge/python-3-blue.svg)](https://www.python.org/downloads/)\r\n[![Linux](https://img.shields.io/badge/os-linux-blue.svg)](https://www.linux.org/)\r\n[![Windows](https://img.shields.io/badge/os-windows-blue.svg)](https://www.microsoft.com/windows/)\r\n\r\n</div>\r\n\r\n## Overview\r\n- [Installation](#installation)\r\n- [Setup](#truckscenes-setup)\r\n- [Usage](#truckscenes-usage)\r\n- [Citation](#citation)\r\n\r\n## Installation\r\nOur devkit is available and can be installed via pip:\r\n```\r\npip install truckscenes-devkit\r\n```\r\n\r\nIf you also want to install all the (optional) dependencies for running the visualizations:\r\n```\r\npip install \"truckscenes-devkit[all]\"\r\n```\r\n\r\nThe usage requires Python (install [here](https://www.python.org/downloads/), tested for 3.6 and 3.8) and pip (install [here](https://pip.pypa.io/en/stable/installation/)) for the installation.\r\n\r\n## TruckScenes Setup\r\nThe MAN TruckScenes dataset can be downloaded on our [Download page](https://www.man.eu/truckscenes/) or search for TruckScenes in the [AWS Open Data Registry](https://registry.opendata.aws/).  \r\n\r\nFor the devkit to work you will need to download **all** archives.  \r\nPlease unpack the archives to the `/data/truckscenes` folder **without** overwriting folders that occur in multiple archives.  \r\nEventually you should have the following folder structure:\r\n```\r\n/data/truckscenes\r\n    samples\t-\tSensor data for keyframes.\r\n    sweeps\t-\tSensor data for intermediate frames.\r\n    v1.0-*\t-\tJSON tables that include all the meta data and annotations. Each split (trainval, test, mini) is provided in a separate folder.\r\n```\r\nIf you want to use another folder, specify the `dataroot` parameter of the TruckScenes class (see [installation](./docs/installation.md)).\r\n\r\n## TruckScenes Usage\r\nPlease follow these steps to make yourself familiar with the MAN TruckScenes dataset:\r\n- [Download](https://www.man.eu/truckscenes/) the dataset on our website.\r\n- Make yourself familiar with the [dataset schema](./docs/schema_truckscenes.md)\r\n- Run the [tutorial](./python-sdk/tutorials/truckscenes_tutorial.ipynb) to get started:\r\n  ```\r\n  jupyter notebook $HOME/truckscenes-devkit/tutorials/truckscenes_tutorial.ipynb\r\n  ```\r\n- Read the [MAN TruckScenes Paper](https://arxiv.org/abs/2407.07462) for a detailed analysis of the dataset.\r\n\r\n## Citation\r\n```\r\n@article{truckscenes2024,\r\n  title={MAN TruckScenes: A multimodal dataset for autonomous trucking in diverse conditions},\r\n  author={Fent, Felix and Kuttenreich, Fabian and Ruch, Florian and Rizwin, Farija and\r\n    Juergens, Stefan and Lechermann, Lorenz and Nissler, Christian and Perl, Andrea and\r\n    Voll, Ulrich and Yan, Min and Lienkamp, Markus},\r\n  journal={arXiv preprint arXiv:2407.07462},\r\n  year={2024}\r\n}\r\n```\r\n\r\n_Copied and adapted from [nuscenes-devkit](https://github.com/nutonomy/nuscenes-devkit)_\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Official development kit of the MAN TruckScenes dataset (www.man.eu/truckscenes).",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/TUMFTM/truckscenes-devkit"
    },
    "split_keywords": [
        "man",
        " truckscenes",
        " dataset",
        " devkit",
        " perception"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe2e64ca23c65a0db7e7cc9e37212d82ce08a66ade94116554bf167bd69c1b08",
                "md5": "d8c9364c36843344aee82952ea7d3826",
                "sha256": "9580d539175cc4e50f5615ed503c8152b3a01b39d442021499b4453b98994546"
            },
            "downloads": -1,
            "filename": "truckscenes_devkit-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d8c9364c36843344aee82952ea7d3826",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 71011,
            "upload_time": "2024-08-01T17:25:06",
            "upload_time_iso_8601": "2024-08-01T17:25:06.406922Z",
            "url": "https://files.pythonhosted.org/packages/fe/2e/64ca23c65a0db7e7cc9e37212d82ce08a66ade94116554bf167bd69c1b08/truckscenes_devkit-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9fad5a14c39e878e4d0c630a8933e5b60872fa526fa41c6e586b68077680dd8",
                "md5": "8df493b335b6a9fc7c8284d1757f55e2",
                "sha256": "0ced870fa21dc2bec7d8e91d4f78ef72a172c85aa3ee795b5f5e217d7a7a80cd"
            },
            "downloads": -1,
            "filename": "truckscenes-devkit-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8df493b335b6a9fc7c8284d1757f55e2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 10068948,
            "upload_time": "2024-08-01T17:25:09",
            "upload_time_iso_8601": "2024-08-01T17:25:09.089150Z",
            "url": "https://files.pythonhosted.org/packages/d9/fa/d5a14c39e878e4d0c630a8933e5b60872fa526fa41c6e586b68077680dd8/truckscenes-devkit-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-01 17:25:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TUMFTM",
    "github_project": "truckscenes-devkit",
    "github_not_found": true,
    "lcname": "truckscenes-devkit"
}
        
Elapsed time: 0.27372s