###########
Amuse Utils
###########

``amuse_util`` is a package for working with the AMUSE code, with Astropy formats, to more easily create and run N-Body simulations.

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

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

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


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

.. toctree::
   :maxdepth: 1

   amuse_util/index
   documentation/benefits
   documentation/testing
   whatsnew/0.1


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

.. toctree::
   :maxdepth: 1

   amuse_util/data/index
   amuse_util/datamodel/index
   amuse_util/ic/index
   amuse_util/simulation/index
   amuse_util/units/index
   amuse_util/utils/index


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

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


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

|DOI|

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

::

   @software{nstarman_zenodo,
     author       = {nstarman},
     title        = {amuse\_util},
     publisher    = {Zenodo},
     doi          = {10.5281/zenodo.3740579},
     url          = {https://doi.org/10.5281/zenodo.3740579}
   }

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


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

.. toctree::
   :maxdepth: 1

   credits
   whatsnew/index.rst