<p align="center">
<img width="260" src="https://raw.githubusercontent.com/maxmahlke/rocks/master/docs/_static/logo_rocks.svg">
</p>
<p align="center">
<a href="https://github.com/maxmahlke/rocks#features"> Features </a> - <a href="https://github.com/maxmahlke/rocks#install"> Install </a> - <a href="https://github.com/maxmahlke/rocks#documentation"> Documentation </a>
</p>
<div align="center">
<a href="https://img.shields.io/pypi/pyversions/space-rocks">
<img src="https://img.shields.io/pypi/pyversions/space-rocks"/>
</a>
<a href="https://img.shields.io/pypi/v/space-rocks">
<img src="https://img.shields.io/pypi/v/space-rocks"/>
</a>
<a href="https://readthedocs.org/projects/rocks/badge/?version=latest">
<img src="https://readthedocs.org/projects/rocks/badge/?version=latest"/>
</a>
<a href="https://arxiv.org/abs/2209.10697">
<img src="https://img.shields.io/badge/arXiv-2209.10697-f9f107.svg"/>
</a>
</div>
## Features
Explore asteroid data on the command-line...
``` sh
$ rocks id 221
(221) Eos
$ rocks class Eos
MB>Outer
$ rocks albedo Eos
0.136 +- 0.004
$ rocks taxonomy Eos
K
$ rocks density Eos
4.559e+03 +- 1.139e+03 kg/m$^3$
```
... and in a `python` script.
``` python
>>> import rocks
>>> rocks.identify("1902ug")
('Fortuna', 19)
>>> ceres = rocks.Rock("ceres")
>>> ceres.diameter.value
848.4
>>> ceres.diameter.unit
'km'
>>> ceres.mass.value
9.384e+20
>>> ceres.mass.error
6.711e+17
```
## Install
Install from PyPi using `pip`:
$ pip install space-rocks
The minimum required `python` version is 3.8.
## Documentation
Check out the documentation at [rocks.readthedocs.io](https://rocks.readthedocs.io/en/latest/) or run
$ rocks docs
For a quick overview, check out the jupyter notebooks:
[Basic Usage](https://github.com/maxmahlke/rocks/blob/master/docs/tutorials/rocks_basic_usage.ipynb) - [Bibliography Management](https://github.com/maxmahlke/rocks/blob/master/docs/tutorials/literature.ipynb)
Raw data
{
"_id": null,
"home_page": "https://rocks.readthedocs.io/en/latest/",
"name": "space-rocks",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Max Mahlke",
"author_email": "max.mahlke@oca.eu",
"download_url": "https://files.pythonhosted.org/packages/97/0a/0b87e07774dab5f7327812ec0ba55dfb9d2b81a4ca91e9955a784e8ee0e3/space_rocks-1.9.9.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img width=\"260\" src=\"https://raw.githubusercontent.com/maxmahlke/rocks/master/docs/_static/logo_rocks.svg\">\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/maxmahlke/rocks#features\"> Features </a> - <a href=\"https://github.com/maxmahlke/rocks#install\"> Install </a> - <a href=\"https://github.com/maxmahlke/rocks#documentation\"> Documentation </a>\n</p>\n\n<div align=\"center\">\n <a href=\"https://img.shields.io/pypi/pyversions/space-rocks\">\n <img src=\"https://img.shields.io/pypi/pyversions/space-rocks\"/>\n </a>\n <a href=\"https://img.shields.io/pypi/v/space-rocks\">\n <img src=\"https://img.shields.io/pypi/v/space-rocks\"/>\n </a>\n <a href=\"https://readthedocs.org/projects/rocks/badge/?version=latest\">\n <img src=\"https://readthedocs.org/projects/rocks/badge/?version=latest\"/>\n </a>\n <a href=\"https://arxiv.org/abs/2209.10697\">\n <img src=\"https://img.shields.io/badge/arXiv-2209.10697-f9f107.svg\"/>\n </a>\n</div>\n\n\n## Features\n\nExplore asteroid data on the command-line...\n\n``` sh\n$ rocks id 221\n(221) Eos\n\n$ rocks class Eos\nMB>Outer\n\n$ rocks albedo Eos\n0.136 +- 0.004\n\n$ rocks taxonomy Eos\nK\n\n$ rocks density Eos\n4.559e+03 +- 1.139e+03 kg/m$^3$\n```\n\n... and in a `python` script.\n\n``` python\n>>> import rocks\n>>> rocks.identify(\"1902ug\")\n('Fortuna', 19)\n>>> ceres = rocks.Rock(\"ceres\")\n>>> ceres.diameter.value\n848.4\n>>> ceres.diameter.unit\n'km'\n>>> ceres.mass.value\n9.384e+20\n>>> ceres.mass.error\n6.711e+17\n```\n\n## Install\n\nInstall from PyPi using `pip`:\n\n $ pip install space-rocks\n\nThe minimum required `python` version is 3.8.\n\n\n## Documentation\n\nCheck out the documentation at [rocks.readthedocs.io](https://rocks.readthedocs.io/en/latest/) or run\n\n $ rocks docs\n\nFor a quick overview, check out the jupyter notebooks:\n\n[Basic Usage](https://github.com/maxmahlke/rocks/blob/master/docs/tutorials/rocks_basic_usage.ipynb) - [Bibliography Management](https://github.com/maxmahlke/rocks/blob/master/docs/tutorials/literature.ipynb)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for SsODNet data access.",
"version": "1.9.9",
"project_urls": {
"Documentation": "https://rocks.readthedocs.io/en/latest/",
"Homepage": "https://rocks.readthedocs.io/en/latest/",
"Repository": "https://github.com/maxmahlke/rocks.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d60a8fbc1f7e7610e4082d38e6b3daa15ee2c11257fc0a1bf33dfb15b082bf7",
"md5": "148ed9b5035f6f4479bb0f05ba047de9",
"sha256": "a90567ec14df74d81fa68ea389d90dbb32c0af30d7ad31b47a5da6a3db3c4db4"
},
"downloads": -1,
"filename": "space_rocks-1.9.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "148ed9b5035f6f4479bb0f05ba047de9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 44588,
"upload_time": "2024-05-13T08:05:26",
"upload_time_iso_8601": "2024-05-13T08:05:26.298955Z",
"url": "https://files.pythonhosted.org/packages/2d/60/a8fbc1f7e7610e4082d38e6b3daa15ee2c11257fc0a1bf33dfb15b082bf7/space_rocks-1.9.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "970a0b87e07774dab5f7327812ec0ba55dfb9d2b81a4ca91e9955a784e8ee0e3",
"md5": "5d7a24d4d662c2075b62152c09057e92",
"sha256": "cb0fb3487e9c5fca0cfa995ca07472a9cc4a0f1136a99f3f5c9f4d3014c43ea9"
},
"downloads": -1,
"filename": "space_rocks-1.9.9.tar.gz",
"has_sig": false,
"md5_digest": "5d7a24d4d662c2075b62152c09057e92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 40191,
"upload_time": "2024-05-13T08:05:28",
"upload_time_iso_8601": "2024-05-13T08:05:28.841519Z",
"url": "https://files.pythonhosted.org/packages/97/0a/0b87e07774dab5f7327812ec0ba55dfb9d2b81a4ca91e9955a784e8ee0e3/space_rocks-1.9.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-13 08:05:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxmahlke",
"github_project": "rocks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "space-rocks"
}
JSON
