An open API service indexing awesome lists of open source software.

https://github.com/maxmahlke/rocks

for space-rocks :new_moon:
https://github.com/maxmahlke/rocks

asteroids astronomy planetary-science python

Last synced: 5 months ago
JSON representation

for space-rocks :new_moon:

Awesome Lists containing this project

README

          




Features - Install - Documentation














## 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)