Python C Jupyter Notebook TeX Fortran PostScript Other
Clone or download
stoiver Update README.rst
Changed target for appveyor badge
Latest commit 3e9f18a May 20, 2018

README.rst

travis ci status appveyor status coverage Latest Version

ANUGA

What is ANUGA?

ANUGA (pronounced "AHnooGAH") is open-source software for the simulation of the shallow water equation, in particular it can be used to model tsunamis and floods.

ANUGA is a python package with some C extensions (and an optional fortran extension). At present ANUGA has not been ported to python 3. We recommend using python 2.7

Developed at Geoscience Australia and Mathematical Sciences Institute at the Australian National University.

Copyright Commonwealth of Australia (Geoscience Australia) and Australian National University 2017

Installation

For installation instructions, see INSTALL.rst

Documentation

ANUGA documentation is available in the doc folder. In particular the user_manual

Also helpful information is available noline at

http://anuga.anu.edu.au

Web sites

The user's site is: http://anuga.anu.edu.au/ The WikiPedia for ANUGA is: https://en.wikipedia.org/wiki/ANUGA_Hydro The GitHub repository for ANUGA is: https://github.com/GeoscienceAustralia/anuga_core

A viewer is available for displaying the ANUGA sww output files. ANUGA viewer repository is: https://github.com/GeoscienceAustralia/anuga-viewer

Mailing Lists

Please see anuga user mailing list here:

anuga-user@lists.sourceforge.net

Latest source code

The latest development version of ANUGA's sources are is available at:

https://github.com/GeoscienceAustralia/anuga_core

They can be downloaded as a zip file or using the Git client as follows

git clone https://github.com/GeoscienceAustralia/anuga_core (for read only) git clone git@github.com:GeoscienceAustralia/anuga_core.git (to contribute)

For the latter option see e.g. https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/ for instructions on how to authenticate using ssh keys.

Bug reports

To search for bugs or report them, please use the ANUGA's Bug Tracker at:

https://github.com/GeoscienceAustralia/anuga_core/issues

Developer information

If you would like to take part in ANUGA development, take a look at CONTRIBUTING.rst.

License information

See the file LICENSE.txt for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

Contacts

At the Australian National University:

Stephen Roberts Lead Developer <stephen.roberts@anu.edu.au>

At Geoscience Australia:

Gareth Davies Developer <gareth.davies@ga.gov.au>