############
Track-Stream
############

This is the documentation for ``trackstream``.

If you are looking for the trackstream paper, a link will be added **here**.

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

.. container::

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


******************
Code Documentation
******************

.. toctree::
   :maxdepth: 1

   documentation/installation
   documentation/testing
   latest version changelog (v0.1) <whatsnew/0.1>


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

.. container::

   |DOI| |License|

Copyright 2020- Nathaniel Starkman.

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

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

::

   @software{zenodo,
     author       = {Starkmanm, Nathaniel},
     title        = trackstream,
     month        = month,
     year         = year,
     publisher    = {Zenodo},
     doi          = {},
     url          = {}
   }


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

.. toctree::
   :maxdepth: 1

   credits
   whatsnew/index
   documentation/code_quality


..
  RST COMMANDS BELOW


.. BADGES

.. |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/trackstream.svg?branch=master
   :target: https://travis-ci.org/nstarman/trackstream

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

.. |DOI| replace:: GET FROM ZENODO

.. |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/trackstream.svg
   :target: https://badge.fury.io/py/trackstream

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

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

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

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