Changeset 9627


Ignore:
Timestamp:
Feb 6, 2015, 9:52:29 AM (10 years ago)
Author:
steve
Message:

Adding in new readme and install documents

Location:
trunk/anuga_core
Files:
1 added
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/anuga_core/README.rst

    r9626 r9627  
    1 
     1.. image:: https://travis-ci.org/stoiver/anuga_core.svg?branch=master
     2    :target: https://travis-ci.org/stoiver/anuga_core
    23
    34=====
    … …  
    1011--------------
    1112
    12 AnuGA (pronounced "an uu ga") is open-source software for the simulation of
     13AnuGA (pronounced "AN uu GA") is open-source software for the simulation of
    1314the shallow water equation, in particular it can be used to model tsunamis
    1415and floods.
     16
     17AnuGA 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 
    1518
    1619Developed at the Risk Assessment Methods Project at Geoscience
    … …  
    2023
    2124Copyright 2004, 2005, 2006, 2015
    22 Ole Nielsen, Stephen Roberts, Duncan Gray, Jane Sexton
     25Ole Nielsen, Stephen Roberts, Duncan Gray, Jane Sexton, Gareth Davies
    2326
    2427
    … …  
    2629------------
    2730
    28 For installation instructions, see ``INSTALL.txt``.
     31For installation instructions, see ``INSTALL.rst``.
    2932
    3033
    … …  
    3538
    3639    http://anuga.anu.edu.au
    37 
    38 How to generate the HTML documentation, see ``doc/README.txt``.
    3940
    4041
    … …  
    5859------------------
    5960
    60 The latest development version of AnuGA's sources are always available at:
     61The latest development version of AnuGA's sources are is available at:
    6162
    6263    https://github.com/stoiver/anuga_core
    … …  
    7778
    7879If you would like to take part in AnuGA development, take a look
    79 at ``HACKING.rst.txt``.
     80at ``HACKING.rst``.
    8081
    8182
    … …  
    8990
    9091
    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 
Note: See TracChangeset for help on using the changeset viewer.