You are in [[http://www.geoinformatics.cc | Geoinformatics - Creative Commons]] :: [[http://www.geoinformatics.cc/doku.php?id=cst-317|Introduction to Earth System Modelling]] :: Software for the Course

====== Introduction to Earth System Modelling: Software ======

===== Software Description  =====

The models described in this course will be developed using [[http://www.terrame.org | TerraME]]. TerraME is an extension of the [[http://www.lua.org|Lua]] language. Please read the following introduction about TerraME, to get a sense of the language and what we are going to teach:

  * A primer on TerraME, 2016.

The next step is to learn the basics of Lua, which is a simple and elegant programming language. We provide an introduction about Lua for TerraME users:

  * [[http://www.terrame.org/lib/exe/fetch.php?media=docs:luaforterrame-ashortintroduction2.pdf|Lua for TerraME: A Short Introduction.]]

===== TerraME =====

The TerraME software is available at the  [[https://github.com/TerraME/terrame/releases |  TerraME github release site]]. 

==== TerraME installation in Windows ====

  - Download the EXE application to your desktop.
  - Double click the EXE application. When prompted for an installation directory, please choose "C:\TerraME". 

==== TerraME installation in MAC OS X  ====

  - Download the DMG application to your Destktop.
  - Double click the DMG application and move the TerraME icon to the Applications folder.
  - In MAC OS X, TerraME should be run from a Terminal. To allow for terminal execution, please add the following line to your ".bash_profile": ''export PATH=$PATH:/Applications/terrame.app/Contents/bin''


===== Zero Brane Studio: IDE for TerraME =====

We suggest that you use [[http://studio.zerobrane.com | ZeroBraneStudio]] as your programming environment for developing TerraME programs. In Windows, please install the program to ''C:\ZeroBraneStudio''. In MAC and Linux, please use the default installation path.

After you download ZeroBraneStudio (ZBS), please do the following steps:


=== Copy configuration files ===

Copy three configuration files below to a directory within Zero Brane Studio installation directory. 

^**File**  ^**What it does**  ^ **Copy to**  |
^[[https://raw.githubusercontent.com/TerraME/terrame/master/ide/zerobrane/lua.lua | lua.lua]]  |Tells ZBS to highlight both Lua and TerraME keywords.  |''ZeroBraneStudio/spec'' (there is already one with this name here, overwrite it) | 
^[[https://raw.githubusercontent.com/TerraME/terrame/master/ide/zerobrane/terrame.lua | terrame.lua]]  |Tells ZBS how to use TerraME.  |''ZeroBraneStudio/interpreters''  |
^[[https://raw.githubusercontent.com/TerraME/terrame/master/ide/zerobrane/user.lua | user.lua]]  |Tells ZBS where to find the TerraME interpreter.  |''ZeroBraneStudio/cfg'' |

The default installation directories for Zero Brane are:

  - Windows: ''C:\ZeroBraneStudio\''
  - Mac: ''/Applications/ZeroBraneStudio.app/Contents/ZeroBraneStudio/''
  - Linux: ''/opt/zbstudio/''

=== Checking if it was correctly configured ===

  - If Zero Brain is running, close it and open again. In **Linux**, to execute TerraME properly, you must run 'zbstudio' from the command line, instead of clicking in the ZeroBrane icon. This will allow ZeroBrane to get your 'TME_PATH'.
  - Go to ''File'' menu, and click ''New''
  - In the main window (which is blank), write ''print("hello")''
  - Save the file with ''.lua'' extension in your computer
  - You will see that the names ''print'' and ''"hello"'' will become colored
  - Go to ''Project'' menu, in ''Lua Interpreter'', select ''TerraME''
  - Click in the green icon with two triangles pointing to the right (''Execute the current project/file'')
  - If everything went fine, you will get the following text in the ''Output'' box in the bottom of Zero Brane:
  - <code>Program 'terrame' started in [...]
hello
Program completed in [...] seconds [...]</code>


===== Additional Packages for TerraME =====

For this course, we are going to use additional packages:

  * sysdyn - modelling system dynamic problems.
  * sci - scientific and statistical functions in TerraME.
  * ca  - cellular automata models.
  * logo - simple agent-based models.

To install these packages, run TerraME, click on the button "Install Package" and select the files one by one.