====== Linux ======
 ===== Installation ====

  - Download the appropriate, pre-compiled executable program for your computer. Unless you have an old or `unusual' machine, this should be
      * [[http://didgeridoo.une.edu.au/km/WOMBAT/wombat64.tar.gz|wombat64.tar.gz]] for a 64-bit machine
      * [[http://didgeridoo.une.edu.au/km/WOMBAT/wombat32.tar.gz|wombat32.tar.gz]] for a 32-bit machine - Update: 32-bit version no longer built
  -   <WRAP  right>{{:wombat:wmbinstall1.jpeg?550|Screenshot 1}}</WRAP>Say you want to keep your WOMBAT in the directory ''<nowiki>MyPrograms</nowiki>'' and that you have moved the file you downloaded to this directory. \\ The screen-shots show this for ''wombat64'' but the procedure is analogous for ''wombat32''. They  show ''<nowiki>MyPrograms</nowiki>'' as a sub-directory of my home directory -- this is not a necessary requirement; for instance, if you have super-user privileges, you may want to choose something like ''/usr/local'' instead.    
      * Change into your selected directory: <code>cd MyPrograms</code>
      * Create a new directory called WOMBAT: <code>mkdir WOMBAT</code>
      * Check that your downloaded file and new directory are there: <code>ls -l</code> should give you something like shown on the right, but, of course, with different names and date.
   -  <WRAP right>{{:wombat:wmbinstall2.jpeg?550|}}</WRAP> Unpack your file into the new directory.
      * Change into directory WOMBAT: <code>cd WOMBAT</code>
      * Unpack the file -- the extension ''.tar.gz''  tells you that this is a gzipped tar file. Hence the command is <code>tar -zxvf ../wombat64.tar.gz</code> This will create a single file ''wombat''.
      * To check that it is there: <code>ls -l</code>
      * The file properties should be ''--rwx--x--x'' with the three ''x'' signifying that this program is executable by anybody. If these are missing for any reason, try: <code>chmod a+x wombat</code> followed by ''ls -l'' to see the change. 
  -  To run the program from any directory, you need to give it the full path name, i.e. in this case <code>/home/kmeyer/MyPrograms/WOMBAT/wombat</code> This can get a bit tedious  to make live simpler -- so that you can run the program by simply typing ''wombat'' -- either:
    - add your equivalent to ''<nowiki>/home/kmeyer/MyPrograms/WOMBAT</nowiki>'' to the PATH statement in the file which is executed whenever you login or start a new shell. 
         * If you are using the bash shell, this is ''.bashrc'' or similar
         * If you are using the csh or tcsh, this is ''.cshrc_usr'' (ubuntu) or similar; look for the ''set path'' statement <code> set path = (.:${HOME}/bin:/usr/local/bin:/usr/bin:$path)
</code> and append the new directory to be searched. In this example, it is <nowiki>''/home/kmeyer/MyPrograms/WOMBAT''</nowiki> or, equivalently <nowiki>''${HOME}/MyPrograms/WOMBAT''</nowiki> <code> set path = (.:${HOME}/bin:/usr/local/bin:/usr/bin:${HOME}/MyPrograms/WOMBAT: $path)
</code>
    - Create a symbolic link to the program from a directory which is already in your search path. For example, <code>cd /usr/local/bin
ln -s /home/kmeyer/MyPrograms/WOMBAT/wombat wombat
</code>You may need super-user or administrator privileges to do so. <wrap column 40% right info> For all three alternatives, you may need to log off and back on again (or start a new shell) before the new setting becomes effective.</wrap>
    - Move the program file to a directory which is in your search path. 
  - If you have previously installed WOMBAT on your machine, make sure that you now 'pick up' the correct, new version, i.e. that you do not inadvertently keep using the old version. The easiest way to do this is by typing <code>wombat --expiry</code> before and after installation -- you should see the change in version/date.
  - Larger analyses in WOMBAT may require more than the default stack size set in your flavour of Linux. If you are planning to run large models, it is a good idea to set the stack size to as large as possible in your .login (or .bashrc or .cshrc_usr) file, e.g. **''ulimit -s''**

====== Testing  ======


<WRAP right>{{:wombat:wmbinstall3.jpeg?550|}}</WRAP>
To test your installation, it is highly recommended that you run one or more of the examples provided.

  - Download an example of your choice, e.g. [[http://didgeridoo.une.edu.au/km/WOMBAT/example1.tar.gz|example1.tar.gz]]
  - Move this this tar file into ''<nowiki>MyPrograms/WOMBAT</nowiki>'' (or another directory of your choice).
  - Unpack the example: <code>tar -zxvf example1.tar.gz</code> This will create the directory ''Examples'' with subdirectory ''Example1''.
  - Change into a subdirectory <code>cd Examples/Example1/A</code>
  - For example 1, the parameter file is ''wombat.par''. This is the default, WOMBAT will look for it if no other name is given. Hence you can run the example by simply typing <code>wombat</code> (if you have followed the steps above to be able to do so) or, equivalently, by typing<code>/home/kmeyer/MyPrograms/WOMBAT/wombat</code> The screenshot below shows the output to the screen you should get.{{:wombat:wmbinstall4.jpeg?700|}}

=== More examples ===

Other small examples to try are:
  *  [[http://didgeridoo.une.edu.au/km/WOMBAT/example2.tar.gz|example2.tar.gz]]
  *  [[http://didgeridoo.une.edu.au/km/WOMBAT/example3.tar.gz|example3.tar.gz]]