########
utilipy
########

Welcome to ``utilipy``, a collection of useful python codes. This is a
centralized repository for non project-specific code. There are modules for making advanced decorators, interfacing with IPython environments, miscellaneous
astronomical functions, data utilities, making fitting libraries
inter-operable, improving 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/utilipy>`_ so if you have any trouble, `open an issue <https://github.com/nstarman/utilipy/issues>`_ there.

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

.. image:: https://travis-ci.org/nstarman/utilipy.svg?branch=master
    :target: https://travis-ci.org/nstarman/utilipy


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

.. toctree::
   :maxdepth: 1

   utilipy/index
   documentation/benefits
   documentation/testing
   whatsnew/1.0


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

.. toctree::
   :maxdepth: 1

   utilipy/config
   utilipy/astro/index
   utilipy/constants/index
   utilipy/data_utils/index
   utilipy/decorators/index
   utilipy/imports/index
   utilipy/ipython/index
   utilipy/math/index
   utilipy/plot/index
   utilipy/scripts/index
   utilipy/utils/index


*********
Tutorials
*********

.. toctree::
   :maxdepth: 1

   examples/ipython-imports.ipynb
   examples/making-decorators.ipynb


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

We welcome contributions from anyone via pull requests on `GitHub
<https://github.com/nstarman/utilipy>`_. 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/utilipy/issues>`_.


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

|DOI|

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

   @software{utilipy:zenodo,
     author       = {nstarman},
     title        = {utilipy v1.0},
     month        = mar,
     year         = 2020,
     publisher    = {Zenodo},
     doi          = {10.5281/zenodo.3724822},
     url          = {https://doi.org/10.5281/zenodo.3724822}
   }

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3545178.svg
   :target: https://doi.org/10.5281/zenodo.3545178


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

.. toctree::
   :maxdepth: 1

   credits
   whatsnew/index.rst