.. _citing:

Citing ANUGA
============

If you use ANUGA in published work, please cite it.

Software
--------

Cite the ANUGA software using the metadata in the repository's ``CITATION.cff``
file — GitHub's **"Cite this repository"** button (top right of the
`repository page <https://github.com/anuga-community/anuga_core>`_) generates an
up-to-date APA or BibTeX entry from it. A minimal BibTeX entry:

.. code-block:: bibtex

   @software{anuga,
     title     = {ANUGA Hydrodynamic Inundation Modelling},
     author    = {Roberts, Stephen and Davies, Gareth and Nielsen, Ole and others},
     publisher = {Australian National University and Geoscience Australia},
     url       = {https://github.com/anuga-community/anuga_core}
   }

ANUGA was created by Geoscience Australia and the Mathematical Sciences Institute
at the Australian National University, and is now maintained by a community of
volunteers.

User manual
-----------

The ANUGA user manual describes the numerical method, the finite-volume
discretisation, and the validation suite, and has a DOI:

   https://dx.doi.org/10.13140/RG.2.2.17267.81446

License
-------

ANUGA is free and open-source software, released under the
`Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
You are free to use, modify, and redistribute it under the terms of that
licence; see ``LICENSE.txt`` in the repository for the full text.