radar-scenes


Nameradar-scenes JSON
Version 1.0.2 PyPI version JSON
download
home_pagehttps://github.com/oleschum/radar_scenes
SummaryHelper Package for the RadarScenes Dataset
upload_time2021-05-14 18:24:50
maintainerOle Schumann
docs_urlNone
authorOle Schumann
requires_python>=3.6
license
keywords radar classification automotive machine learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # RadarScenes Tools

## About
![viewer example](https://github.com/oleschum/radar_scenes/blob/master/doc/viewer.png?raw=true)

This python package provides some helper scripts for the [RadarScenes](http://radar-scenes.com) dataset. 

Among others, the package contains a viewer for the radar data and camera images from the dataset.

## Installation

The package is designed for Python versions `>=3.6` and can be installed using `pip`. Installation using `pip` is the
recommended method. 

The alternative is to clone this repository and manually install the package using the `setup.py`.

### Virtual Environment
It is *highly recommended* to install the package in its own virtual environment. To do so, create a virtual environment 
prior to installation of the package:

```
python3 -m venv ~/.virtualenvs/radar_scenes
```
This will create a python virtual environment called `radar_scenes` in the folder `.virtualenvs` in your home directory.

This environment can be activated via
```
source ~/.virtualenvs/radar_scenes/bin/activate
```
An active virtual environment is indicated by a preceding `(radar_scenes)` line before the usual bash prompt.

Once the virtual environment is active, the package can be installed with the command

```
pip install radar_scenes
```
You do not have to clone this repository for the installation.

There are multiple guides available which give more information about virtual environments and installation of python
packages, e.g. on [python.org](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
### System wide installation
If no virtual environment is desired (again, this is __discouraged__!) , the package can be installed using the global version of `pip`
```
pip3 install --user radar_scenes
```
The flag `--user` can be omitted if a system wide installation is desired (may require root privileges).




## Citation
Please refer to www.radar-scenes.com to get instructions on how to cite the data set. 


## Usage

After successful installation, the `radar_scenes` package is available in your python environment.

### Radar Data Viewer
During installation, the command `rad_viewer` is made available. If you have installed the package into a virtual
environment, this command is only available while the virtual environment is active.

Calling `rad_viewer` launches the radar data viewer. As an optional command line argument, a path to a `*.json` file 
from the RadarScenes dataset can be provided. The sequence will then be loaded directly on start up.

Example:
```
(radar_scenes)
$ rad_viewer ~/datasets/radar_scenes/data/sequence_128/scenes.json
```

The time slider itself or the arrow keys on your keyboard can be used to scroll through the sequence.

## License
This project is licensed under the terms of the MIT license.

Notice, however, that the RadarScenes data set itself comes with a different license.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/oleschum/radar_scenes",
    "name": "radar-scenes",
    "maintainer": "Ole Schumann",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "radar,classification,automotive,machine learning",
    "author": "Ole Schumann",
    "author_email": "hello@radar-scenes.com",
    "download_url": "https://files.pythonhosted.org/packages/1d/7a/ceeb775cc3abe5846c4a1e88f95f3eca4f3bd6705187b74c5dd6914a9f61/radar_scenes-1.0.2.tar.gz",
    "platform": "",
    "description": "# RadarScenes Tools\n\n## About\n![viewer example](https://github.com/oleschum/radar_scenes/blob/master/doc/viewer.png?raw=true)\n\nThis python package provides some helper scripts for the [RadarScenes](http://radar-scenes.com) dataset. \n\nAmong others, the package contains a viewer for the radar data and camera images from the dataset.\n\n## Installation\n\nThe package is designed for Python versions `>=3.6` and can be installed using `pip`. Installation using `pip` is the\nrecommended method. \n\nThe alternative is to clone this repository and manually install the package using the `setup.py`.\n\n### Virtual Environment\nIt is *highly recommended* to install the package in its own virtual environment. To do so, create a virtual environment \nprior to installation of the package:\n\n```\npython3 -m venv ~/.virtualenvs/radar_scenes\n```\nThis will create a python virtual environment called `radar_scenes` in the folder `.virtualenvs` in your home directory.\n\nThis environment can be activated via\n```\nsource ~/.virtualenvs/radar_scenes/bin/activate\n```\nAn active virtual environment is indicated by a preceding `(radar_scenes)` line before the usual bash prompt.\n\nOnce the virtual environment is active, the package can be installed with the command\n\n```\npip install radar_scenes\n```\nYou do not have to clone this repository for the installation.\n\nThere are multiple guides available which give more information about virtual environments and installation of python\npackages, e.g. on [python.org](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n### System wide installation\nIf no virtual environment is desired (again, this is __discouraged__!) , the package can be installed using the global version of `pip`\n```\npip3 install --user radar_scenes\n```\nThe flag `--user` can be omitted if a system wide installation is desired (may require root privileges).\n\n\n\n\n## Citation\nPlease refer to www.radar-scenes.com to get instructions on how to cite the data set. \n\n\n## Usage\n\nAfter successful installation, the `radar_scenes` package is available in your python environment.\n\n### Radar Data Viewer\nDuring installation, the command `rad_viewer` is made available. If you have installed the package into a virtual\nenvironment, this command is only available while the virtual environment is active.\n\nCalling `rad_viewer` launches the radar data viewer. As an optional command line argument, a path to a `*.json` file \nfrom the RadarScenes dataset can be provided. The sequence will then be loaded directly on start up.\n\nExample:\n```\n(radar_scenes)\n$ rad_viewer ~/datasets/radar_scenes/data/sequence_128/scenes.json\n```\n\nThe time slider itself or the arrow keys on your keyboard can be used to scroll through the sequence.\n\n## License\nThis project is licensed under the terms of the MIT license.\n\nNotice, however, that the RadarScenes data set itself comes with a different license.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Helper Package for the RadarScenes Dataset",
    "version": "1.0.2",
    "split_keywords": [
        "radar",
        "classification",
        "automotive",
        "machine learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "922de5ee2d4138f86c6fe69675c767e0",
                "sha256": "3bac143f66d4398503a69d996d74929a45c57a24609d7dff71a7dbca52f7bf7f"
            },
            "downloads": -1,
            "filename": "radar_scenes-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "922de5ee2d4138f86c6fe69675c767e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 149199,
            "upload_time": "2021-05-14T18:24:48",
            "upload_time_iso_8601": "2021-05-14T18:24:48.726209Z",
            "url": "https://files.pythonhosted.org/packages/85/f9/bff99e9194e24dfaae9f1345934f12a10e4acd192167dc075f1d6211f522/radar_scenes-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4a85c8227d561a0325cf6cf512c9b109",
                "sha256": "e7d17d1cd1a43ccfecb67b75482b507de70e4aa41ee31248d3dde5a0b2d2e6f5"
            },
            "downloads": -1,
            "filename": "radar_scenes-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4a85c8227d561a0325cf6cf512c9b109",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 149421,
            "upload_time": "2021-05-14T18:24:50",
            "upload_time_iso_8601": "2021-05-14T18:24:50.485936Z",
            "url": "https://files.pythonhosted.org/packages/1d/7a/ceeb775cc3abe5846c4a1e88f95f3eca4f3bd6705187b74c5dd6914a9f61/radar_scenes-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-05-14 18:24:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "oleschum",
    "error": "Could not fetch GitHub repository",
    "lcname": "radar-scenes"
}
        
Elapsed time: 0.26236s