Changeset 9635

Timestamp:

Feb 6, 2015, 4:37:45 PM (9 years ago)

Author:

steve

Message:

Adding in some extra doc files

Location:

trunk/anuga_core

Files:

• CONTRIBUTING.rst (added)
• INSTALL.rst (modified) (3 diffs)
• MANIFEST.in (added)
• README.rst (modified) (1 diff)
• setup.py (modified) (3 diffs)

trunk/anuga_core/INSTALL.rst

@@ -1 +1 @@
 
 
-.. image:: https://travis-ci.org/stoiver/anuga_core.svg?branch=master
-    :target: https://travis-ci.org/stoiver/anuga_core
-
-
-============
 Installation
 ============
@@ -14 +9 @@
 ------------
 
-AnuGA is a python package with some C extensions (and an optional fortran extension). At present AnuGA has not been transported to python 3. We recommend using python 2.7. 
+AnuGA is a python package with some C extensions (and an optional fortran 
+extension). At present AnuGA has not been transported to python 3. 
+We recommend using python 2.7. 
 
-If you have a python 2.7 environment with gcc and gfortran support, then you can use easy_install to install the latest release version of AnuGA. 
+If you have a python 2.7 environment with gcc and gfortran support, 
+then you can use easy_install to install the latest release 
+version of AnuGA. 
 
 
@@ -22 +21 @@
 ------------------
 
-A safe way to install AnuGA is to use a separate python environment to isolate it from the rest of your system. Miniconda provides such an environment. 
+A safe way to install AnuGA is to use a separate python environment 
+to isolate it from the rest of your system. Miniconda provides such 
+an environment. 
 
 

trunk/anuga_core/README.rst

@@ -11 +11 @@
 --------------
 
-AnuGA (pronounced "AN uu GA") is open-source software for the simulation of
+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  
+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 the Risk Assessment Methods Project at Geoscience

trunk/anuga_core/setup.py

@@ -5 +5 @@
     and outflow, and then the simulation is run.
 
-    This is the public API to ANUGA. It provides a toolkit of often-used
-    modules, which can be used directly by including the following line in
-    the user's code:
-
-    import anuga
-        
-    This usage pattern abstracts away the internal heirarchy of the ANUGA
-    system, allowing the user to concentrate on writing simulations without
-    searching through the ANUGA source tree for the functions that they need.
-    
-    Also, it isolates the user from "under-the-hood" refactorings.
+    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 the Risk Assessment Methods Project at Geoscience
+    Australia and Mathematical Sciences Institute at the Australian
+    National University.
+
+
+Copyright 2004, 2005, 2006, 2015 
+Ole Nielsen, Stephen Roberts, Duncan Gray, Jane Sexton, Gareth Davies
+
 """
 
@@ -183 +184 @@
     write_version_py()
 
+
+    with open('README.rst') as file:
+        long_description = file.read()
+    
     metadata = dict(
         name = 'anuga',
@@ -188 +193 @@
         maintainer_email = "anuga-user@lists.sourceforge.net",
         description = DOCLINES[0],
-        long_description = "\n".join(DOCLINES[2:]),
+        long_description = long_description,
         url = "http://anuga.anu.edu.au",
         author = "Stephen Roberts, Ole Nielsen et al.",