search

NASA-Planetary-Science / sbpy

A Python package for small bodies research
https://sbpy.org/
Other
68 stars 34 forks source link
asteroids astronomy comets research

readme

.. image:: https://github.com/NASA-Planetary-Science/sbpy/raw/main/logo/sbpy_logo_short.png :width: 400px :align: center
:alt: sbpy

sbpy is an Astropy <https://www.astropy.org/>_ affiliated package for small-body planetary astronomy.

.. image:: https://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat :target: http://www.astropy.org :alt: Powered by Astropy Badge

.. image:: https://github.com/NASA-Planetary-Science/sbpy/actions/workflows/ci_cron_weekly.yml/badge.svg :target: https://github.com/NASA-Planetary-Science/sbpy/actions :alt: GitHub testing status

.. image:: https://readthedocs.org/projects/sbpy/badge/?version=latest :target: https://sbpy.readthedocs.io/en/latest/?badge=latest :alt: Documentation status

.. image:: https://joss.theoj.org/papers/10.21105/joss.01426/status.svg :target: https://doi.org/10.21105/joss.01426 :alt: JOSS documentation

.. image:: https://codecov.io/gh/NASA-Planetary-Science/sbpy/branch/main/graph/badge.svg :target: https://codecov.io/gh/NASA-Planetary-Science/sbpy :alt: codecov status

Overview

For an overview of the sbpy project please visit the project overview page <https://sbpy.readthedocs.io/en/latest/about.html> and the official sbpy website <https://sbpy.org>.

Installation

The current stable version of sbpy can be installed with pip:

.. code-block:: bash

$ pip install sbpy

For details on the installation process, please refer to the detailed installation guide <https://sbpy.readthedocs.io/en/latest/install.html>_.

Documentation

The official documentation and API reference <https://sbpy.readthedocs.io/en/latest/>_ is avilable.

Status

sbpy is still under development, with v1.0 scheduled for delivery in 2024. For an overview on the status of individual features see the Status Page <https://sbpy.readthedocs.io/en/latest/status.html>_.

Acknowledgements

sbpy support provided by NASA PDART Grant Nos. 80NSSC18K0987 and 80NSSC22K0143.

If you use sbpy in your work, please acknowledge it by citing

`Mommert, Kelley, de-Val Borro, Li et al., (2019). sbpy: A Python module for small-body planetary astronomy. Journal of Open Source Software, 4(38), 1426 <https://joss.theoj.org/papers/8b8e7bb15fb4a14f80f2afd06b6ce060>`_