Skip to content

maxmahlke/rocks

Repository files navigation

Features - Install - Documentation

Features

Explore asteroid data on the command-line...

$ 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.

>>> 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 or run

 $ rocks docs

For a quick overview, check out the jupyter notebooks:

Basic Usage - Bibliography Management