| 1 | |
|---|
| 2 | |
|---|
| 3 | ===== |
|---|
| 4 | AnuGA |
|---|
| 5 | ===== |
|---|
| 6 | |
|---|
| 7 | .. contents:: |
|---|
| 8 | |
|---|
| 9 | What is AnuGA? |
|---|
| 10 | -------------- |
|---|
| 11 | |
|---|
| 12 | AnuGA (pronounced "an uu ga") is open-source software for the simulation of |
|---|
| 13 | the shallow water equation, in particular it can be used to model tsunamis |
|---|
| 14 | and floods. |
|---|
| 15 | |
|---|
| 16 | Developed at the Risk Assessment Methods Project at Geoscience |
|---|
| 17 | Australia and Mathematical Sciences Institute at the Australian |
|---|
| 18 | National University. |
|---|
| 19 | |
|---|
| 20 | |
|---|
| 21 | Copyright 2004, 2005, 2006, 2015 |
|---|
| 22 | Ole Nielsen, Stephen Roberts, Duncan Gray, Jane Sexton |
|---|
| 23 | |
|---|
| 24 | |
|---|
| 25 | Installation |
|---|
| 26 | ------------ |
|---|
| 27 | |
|---|
| 28 | For installation instructions, see ``INSTALL.txt``. |
|---|
| 29 | |
|---|
| 30 | |
|---|
| 31 | Documentation |
|---|
| 32 | ------------- |
|---|
| 33 | |
|---|
| 34 | AnuGA documentation is available in the user_manual folder or online |
|---|
| 35 | |
|---|
| 36 | http://anuga.anu.edu.au |
|---|
| 37 | |
|---|
| 38 | How to generate the HTML documentation, see ``doc/README.txt``. |
|---|
| 39 | |
|---|
| 40 | |
|---|
| 41 | Web sites |
|---|
| 42 | --------- |
|---|
| 43 | |
|---|
| 44 | The user's site is: |
|---|
| 45 | |
|---|
| 46 | http://anuga.anu.edu.au/ |
|---|
| 47 | |
|---|
| 48 | |
|---|
| 49 | Mailing Lists |
|---|
| 50 | ------------- |
|---|
| 51 | |
|---|
| 52 | Please see anuga user mailing list here: |
|---|
| 53 | |
|---|
| 54 | anuga-user@lists.sourceforge.net |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | Latest source code |
|---|
| 58 | ------------------ |
|---|
| 59 | |
|---|
| 60 | The latest development version of AnuGA's sources are always available at: |
|---|
| 61 | |
|---|
| 62 | https://github.com/stoiver/anuga_core |
|---|
| 63 | |
|---|
| 64 | They can be downloaded as a zip file or using the Git client. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | Bug reports |
|---|
| 68 | ----------- |
|---|
| 69 | |
|---|
| 70 | To search for bugs or report them, please use the AnuGA's Bug Tracker at: |
|---|
| 71 | |
|---|
| 72 | https://github.com/stoiver/anuga_core/issues |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | Developer information |
|---|
| 76 | --------------------- |
|---|
| 77 | |
|---|
| 78 | If you would like to take part in AnuGA development, take a look |
|---|
| 79 | at ``HACKING.rst.txt``. |
|---|
| 80 | |
|---|
| 81 | |
|---|
| 82 | License information |
|---|
| 83 | ------------------- |
|---|
| 84 | |
|---|
| 85 | See the file ``LICENSE.txt`` for information on the history of this |
|---|
| 86 | software, terms & conditions for usage, and a DISCLAIMER OF ALL |
|---|
| 87 | WARRANTIES. |
|---|
| 88 | |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | This is the root-Subversion directory for the ANUGA Inundation |
|---|
| 94 | Software Development project conducted by |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | PREREQUISITES |
|---|
| 102 | |
|---|
| 103 | python 2.3 or later |
|---|
| 104 | python-numeric |
|---|
| 105 | python-dev (Interestingly, numeric seems to be installed as well) |
|---|
| 106 | python-scientific (or maybe only python-netcdf) |
|---|
| 107 | (Remember to put netcdf.dll somewhere so the PATH - e.g. in C:\bin) |
|---|
| 108 | |
|---|
| 109 | A C compiler such as gcc (from GNU in case of Linux and MinGW in case of Windows) |
|---|
| 110 | |
|---|
| 111 | RECOMMENDED |
|---|
| 112 | psyco |
|---|
| 113 | visual python |
|---|
| 114 | matplotlib (pylab) for quality 2d plotting |
|---|
| 115 | weave? |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | INSTALLATION |
|---|
| 119 | |
|---|
| 120 | In directory anuga: |
|---|
| 121 | |
|---|
| 122 | python test_all.py |
|---|
| 123 | |
|---|
| 124 | |
|---|
| 125 | PATH |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | PATH=C:\Python24;C:\MinGW\bin;C:\Program Files\anuga_viewer |
|---|
| 129 | |
|---|
| 130 | It is assumed that the root directory for all anugu modules is on the pythonpath, e.g. |
|---|
| 131 | PYTHONPATH=V:\home\onielsen\anuga_core\source |
|---|
| 132 | Alternatively this directory should be copied to the python site_packages directory |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | LINKS |
|---|
| 138 | Python: http://www.python.org |
|---|
| 139 | Visual Python: http://vpython.org/ |
|---|
| 140 | Python NetCDF Interface: http://www-md.fsl.noaa.gov/eft/developer/netCDFPythonInterface.html |
|---|
| 141 | Psyco: http://psyco.sourceforge.net/index.html |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | LICENSE |
|---|
| 145 | see LICENSE.txt |
|---|
| 146 | |
|---|
| 147 | |
|---|
