########
astronat
########

Welcome to ``astronat``, a collection of astrophysics-concomitant python codes. There are modules for astronomical functions, improved astropy units and quantity-enabled functions, and much more.

The package is being actively developed in a `public repository on GitHub <https://github.com/nstarman/astronat>`_ so if you have any trouble, `open an issue <https://github.com/nstarman/astronat/issues>`_ there.

.. container::

   |DOI| |PyPI| |Build Status| |Coveralls| |astropy|


*************
Documentation
*************

.. toctree::
   :maxdepth: 1

   astronat/index
   documentation/installation
   documentation/benefits
   documentation/testing
   whatsnew/0.1


***********
Subpackages
***********

.. toctree::
   :maxdepth: 1

   astronat/constants/index
   astronat/units/index
   astronat/utils/index


*****************
How to contribute
*****************

|Milestones| |Open Issues| |Last Commit|

We welcome contributions from anyone via pull requests on `GitHub
<https://github.com/nstarman/astronat>`_. If you don't feel comfortable modifying or
adding functionality, we also welcome feature requests and bug reports as
`GitHub issues <https://github.com/nstarman/astronat/issues>`_.

The development process follows that of the `astropy-package-template <https://docs.astropy.org/en/latest/development/astropy-package-template.html>`_ from Astropy's `release procedure <https://docs.astropy.org/en/latest/development/releasing.html#release-procedure>`_.


***********
Attribution
***********

|DOI| |License|

Copyright 2018- Nathaniel Starkman and contributors.

``astronat`` is free software made available under the BSD-3 License. For details see the `LICENSE <https://github.com/nstarman/utilitpy/blob/master/LICENSE>`_ file.

If you make use of this code, please consider citing the Zenodo DOI as a software citation::

   @software{astronat:zenodo,
     author       = {nstarman},
     title        = {astronat},
     publisher    = {Zenodo},
     doi          = {10.5281/zenodo.3491011},
     url          = {https://doi.org/10.5281/zenodo.3491011}
   }



***************
Project details
***************

.. toctree::
   :maxdepth: 1

   credits
   whatsnew/index.rst
   documentation/code_quality


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

.. |Build Status| image:: https://travis-ci.org/nstarman/astronat.svg?branch=master
   :target: https://travis-ci.org/nstarman/astronat

.. |Documentation Status| image:: https://readthedocs.org/projects/astronat/badge/?version=latest
   :target: https://astronat.readthedocs.io/en/latest/?badge=latest

.. |DOI| image:: https://zenodo.org/badge/192425953.svg
   :target: https://zenodo.org/badge/latestdoi/192425953

.. |License| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
   :target: https://opensource.org/licenses/BSD-3-Clause

.. |PyPI| image:: https://badge.fury.io/py/astronat.svg
   :target: https://badge.fury.io/py/astronat

.. |Milestones| image:: https://img.shields.io/github/milestones/open/nstarman/astronat?style=flat
   :alt: GitHub milestones

.. |Open Issues| image:: https://img.shields.io/github/issues-raw/nstarman/astronat?style=flat
   :alt: GitHub issues

.. |Last Commit| image:: https://img.shields.io/github/last-commit/nstarman/astronat/master?style=flat
   :alt: GitHub last commit (branch)

.. |Coveralls| image:: https://coveralls.io/repos/github/nstarman/astronat/badge.svg?branch=master
   :target: https://coveralls.io/github/nstarman/astronat?branch=master