= Installing current version of ANUGA research code on Windows  =

== Packages to install ==

Install python (and associated packages). We use {{{python}}} as our programming environment and a number of standard python packages such as {{{numpy, scipy, matplotlib}}}.  One of the easiest ways to install all the required (except for {{{netcdf}}} is to use the {{{python_xy}}} distribution. 

So first install[http://code.google.com/p/pythonxy/ python xy] This will be a large download, but will provide an almost complete installation of {{{python}} for our needs. Choose the {{python 2.7}}} version. 


=== Scientific python ===

We use scientific python to provide netcdf
support in python. 

Unfortunately {{{python xy}}} doesn't provide {{{scientific python}}}. A pre-compiled version is available from [http://www.lfd.uci.edu/~gohlke/pythonlibs/#scientificpython scientific python].  Be sure to choose the version matching your version of {{{python}}}. 


== Installing anuga ==

Now we should have installed all the packages necessary to run anuga. 
So now to actually installing anuga. 

=== Checkout anuga via svn ===

First we need to get the actual anuga source code. We do this by checking out the anuga 
repository using subversion. I suggest installing [http://tortoisesvn.net/ tortoise svn] and then checkout the following svn repository

{{{
https://anuga.anu.edu.au/svn/anuga/trunk/anuga_core
}}}

This should produce an anuga_core directory

=== Setup PYTHONPATH ===

We need to tell python where the anuga source code is located. 
This is done via the {{{PYTHONPATH}}} environment variable.


=== Compile ANUGA Code ===

Now go to the directory anuga_core and compile the anuga files via: 
Fire up a cmd terminal, change to the {{{anuga_core}}} directory and run

{{{
python compile_all.py
}}}

=== Run Unit tests ===

From the anuga_core directory run the unit tests via:

{{{
python test_all.py
}}}

== Conclusion ==

Hopefully all the unit tests pass. As this is bleeding edge there are sometimes a small number of failures as this is a work in progress. Have a look at the demos in the directory anuga_core/documentation/user_manual/demos (along with the user manual) to see how to use anuga.

== Updating ==

From time to time you should update your version of anuga. This is fairly easy. When you installed {{{tortoise svn}}} a few extra menu items are added to your right click menu in the file manager. Just choose "tortoise" update to update the code. 

Then again from the {{{anuga_core}}} directory recompile the code and check the unit tests via

{{{
python compile_all.py
python test_all.py
}}}