rtb-data


Namertb-data JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/petercorke/roboticstoolbox-python
SummaryData files for the Robotics Toolbox for Python.
upload_time2023-05-16 10:32:36
maintainer
docs_urlNone
authorPeter Corke
requires_python
license
keywords python robotics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Robotics Toolbox for Python - data files

[![PyPI version](https://badge.fury.io/py/rtb-data.svg)](https://badge.fury.io/py/rtb-data)
[![Anaconda version](https://anaconda.org/conda-forge/rtb-data/badges/version.svg)](https://anaconda.org/conda-forge/rtb-datan)

<table style="border:0px">
<tr style="border:0px">
<td style="border:0px">
<img src="https://github.com/petercorke/robotics-toolbox-python/raw/master/docs/figs/RTBDataLogo.png" width="200"></td>
<td style="border:0px">
This package includes large data files associated with the Robotics Toolbox for Python (RTB-P).
</td>
</tr>
</table>


## Rationale

The data files are provided as a separate package to work around disk space limitations on PyPI.  Including these data with the RTB code adds nearly 200MB to every release, which will blow the PyPI limit quite quickly.  
Since the data doesn't change very much, it's mostly robot models and a few data sets, it makes sense for it to be a standalone package.

## Package contents

| Folder | Purpose                        |
| ------ | ------------------------------ |
| data   | miscellaneous STL files and data sets |
| meshes | STL mesh models for DH robots         |
| xacro  | URDF/xacro models for URDF robots     |      

## Accessing data within the package

The Toolbox function `path_to_datafile(file)` will return an absolute
`Path` to `file` which is relative to the root of the data package.  For example

```
loadmat("data/map1.mat")   # read rtbdata/data/map1.mat
loadmat("foo.dat")         # read ./foo.dat
loadmat("~/foo.dat")       # read $HOME/foo.dat
```

A matching local file takes precendence over a file in the data package.

## Installing the package

You don't need to explicitly install this package, it happens automatically when you when you install RTB-P

```
pip install roboticstoolbox-python
```
since it is a dependency.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/petercorke/roboticstoolbox-python",
    "name": "rtb-data",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python robotics",
    "author": "Peter Corke",
    "author_email": "rvc@petercorke.com",
    "download_url": "https://files.pythonhosted.org/packages/9e/da/3c7eae56fc32512e89eb239f7f7bb180764a4ca796c2e077166ed439fea9/rtb-data-1.0.1.tar.gz",
    "platform": null,
    "description": "# Robotics Toolbox for Python - data files\n\n[![PyPI version](https://badge.fury.io/py/rtb-data.svg)](https://badge.fury.io/py/rtb-data)\n[![Anaconda version](https://anaconda.org/conda-forge/rtb-data/badges/version.svg)](https://anaconda.org/conda-forge/rtb-datan)\n\n<table style=\"border:0px\">\n<tr style=\"border:0px\">\n<td style=\"border:0px\">\n<img src=\"https://github.com/petercorke/robotics-toolbox-python/raw/master/docs/figs/RTBDataLogo.png\" width=\"200\"></td>\n<td style=\"border:0px\">\nThis package includes large data files associated with the Robotics Toolbox for Python (RTB-P).\n</td>\n</tr>\n</table>\n\n\n## Rationale\n\nThe data files are provided as a separate package to work around disk space limitations on PyPI.  Including these data with the RTB code adds nearly 200MB to every release, which will blow the PyPI limit quite quickly.  \nSince the data doesn't change very much, it's mostly robot models and a few data sets, it makes sense for it to be a standalone package.\n\n## Package contents\n\n| Folder | Purpose                        |\n| ------ | ------------------------------ |\n| data   | miscellaneous STL files and data sets |\n| meshes | STL mesh models for DH robots         |\n| xacro  | URDF/xacro models for URDF robots     |      \n\n## Accessing data within the package\n\nThe Toolbox function `path_to_datafile(file)` will return an absolute\n`Path` to `file` which is relative to the root of the data package.  For example\n\n```\nloadmat(\"data/map1.mat\")   # read rtbdata/data/map1.mat\nloadmat(\"foo.dat\")         # read ./foo.dat\nloadmat(\"~/foo.dat\")       # read $HOME/foo.dat\n```\n\nA matching local file takes precendence over a file in the data package.\n\n## Installing the package\n\nYou don't need to explicitly install this package, it happens automatically when you when you install RTB-P\n\n```\npip install roboticstoolbox-python\n```\nsince it is a dependency.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Data files for the Robotics Toolbox for Python.",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/petercorke/roboticstoolbox-python",
        "Source": "https://github.com/petercorke/roboticstoolbox-python"
    },
    "split_keywords": [
        "python",
        "robotics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9eda3c7eae56fc32512e89eb239f7f7bb180764a4ca796c2e077166ed439fea9",
                "md5": "c8f30163768002ff5b07d272d209b43f",
                "sha256": "c51292ddcdf5962e59456c3a5ab62a4d540a5ea5bdd4e35b2963f9ec3825cf1d"
            },
            "downloads": -1,
            "filename": "rtb-data-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "c8f30163768002ff5b07d272d209b43f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 114741056,
            "upload_time": "2023-05-16T10:32:36",
            "upload_time_iso_8601": "2023-05-16T10:32:36.602203Z",
            "url": "https://files.pythonhosted.org/packages/9e/da/3c7eae56fc32512e89eb239f7f7bb180764a4ca796c2e077166ed439fea9/rtb-data-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-16 10:32:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "petercorke",
    "github_project": "roboticstoolbox-python",
    "github_not_found": true,
    "lcname": "rtb-data"
}
        
Elapsed time: 0.19280s