Model folder description - GLOBIO4/GlobioModelPublic GitHub Wiki

After installing GLOBIO 4 the main directory contains the following sub directories:

  \                    Main GLOBIO directory.
  \Calculations        The GLOBIO calculations.
  \Common              Common Python modules.
  \Config              Configurations files.
  \Core                Core Python modules.
  \LanduseAllocation   Discrete land-use allocation modules.
  \Preprocessing       Pre-processing modules.
  \Scripts             Scripts examples.
  \Suitability         Suitability modules.
  \Test                For testing.    
    \Calculations      Test calculations.
    \Core              Core Python testing modules.
    \TestInfo          Test run info.
    \TestScripts       Test scripts.
  \Tools               Extra tools.
  \Workers             Multiprocessing modules.

In several directories a file __init__.py exists. In Eclipse/PyDev this file indicates the directory is a Python package.

Main directory

The GLOBIO main directory contains the command file to run GLOBIO 4. The following file is present:

globio4.bat

The Windows bat-file to run GLOBIO 4.

globio4.sh

The Linux shell-file to run GLOBIO 4.

run.bat

The Windows bat-file to run a python script.

run.sh

The Linux shell-file to run a python script.

run_arcgis.bat

The Windows bat-file to run a python script with arcpy.

Directory - Calculations

The directory \Calculations contains the GLOBIO_ files with the GLOBIO 4 calculations. The following common files are present:

  • GLOBIO_CompareRasters.py
    • Compares two rasters and calculates the differences. This module can be used to compare a raster to its reference to check if changes in the code has no effect on the results.
  • GLOBIO_ZonalMean.py
    • Calculates the zonal mean.

For detailed information about the calculations see "GLOBIO 3.5 model description (summary), 4 December 2015".

Directory - Common

The directory \Common contains Python modules with general common used methods. The following files are present:

  • Timer.py
    • General timer class.
  • Utils.py
    • General utility methods.

Directory - Config

The directory \Config contains Python modules and GLOBIO scripts with configuration settings. The following Python modules are present:

  • Constants_Config.py
    • Defines all constants.
  • Types_Config.py
    • Defines all types.
  • Variables_Config.py
    • Defines the predefined global variables. All these variables are required by the GLOBIO application.

The following GLOBIO configuration common files are present:

  • Globio_Config.glo
    • Defines additional predefined global variables and sets initial values. The variables defined here are not required by the GLOBIO application. They are used in the defined calculation modules.
  • Globio_ConfigLinux.glo
    • Optional. Defines additional predefined global variables and sets initial values when running under Linux. If this file is not found the Globio_Config.glo is used
  • Globio_Modules.glo
    • Defines the predefined Terrestrial calculation modules.
  • Globio_Utilities.glo
    • Defines the predefined utility modules.

Directory - Core

The directory \Core contains the core Python modules. The following Python modules are present:

  • AppUtils.py
    • General application utility methods.
  • CSVFile.py
    • A class for reading CSV files.
  • CalculationArcGIS.py
    • The base class for ArcGIS calculations.
  • CalculationBase.py
    • The base class for all GLOBIO_ calculations.
  • CellArea.py
    • A module for calculating raster cell areas.
  • CellArea_v2.py
    • A module for calculating raster cell areas. This module uses the geographiclib library.
  • Commands.py
    • A class used when parsing run configuration files.
  • Constants.py
    • A class for constants.
  • Convert.py
    • A module for converting rasters and vector datasets.
  • DocUtils.py
    • A module for showing doc information.
  • Error.py
    • A module with used error numbers and messages.
  • Globals.py
    • A module with global variables.
  • Globio4.py
    • The main GLOBIO 4 module.
  • Grass.py
    • A class for doing calculations in GRASS.
  • Logger.py
    • A class for logging.
  • Lookup.py
    • A class for reading lookup csv files and performing the value lookup.
  • Monitor.py
    • A class for getting information about the memory and disk usage during a run.
  • Raster.py
    • A class for reading and writing to raster datasets and performing raster calculations.
  • RasterUtils.py
    • Raster utility methods.
  • ScriptBase.py
    • Several classes used for executing blocks with commands.
  • ScriptLines.py
    • A class to contain information about a script line (content, script file, line number etc.).
  • Types.py
    • A class for types.
  • Variables.py
    • A class for variables.
  • Vector.py
    • A class for reading and writing vector datasets.
  • VectorUtils.py
    • Vector utility methods.
  • WorkerBase.py
    • A base class for multiprocessing calculations.

Directory - LandAllocation

The directory \LandAllocation contains additional Python modules used for the Discrete Land-use Allocation calculation.

Directory - Preprocessing

The directory \Preprocessing contains Python modules for creating input data for the Aquatic module.

Directory - Scripts

The directory \Scripts contains some example GLOBIO run scripts. The following files are present:

  • Run_All.glo
    • Executes a full run of the terrestric part of GLOBIO.
  • Settlements.glo
    • Calculates the settlements land-use.

Directory - Suitability

The directory \Suitability contains additional Python modules used for calculate land-use suitability rasters.

Several scripts use ESRI ArcPy so an ArcGIS license is required.

Directory - Workers

The directory \Workers contains Python modules which are mainly used by the pre-processing modules and implement WorkerBase derivatives for doing multiprocessing calculations.

Directory - Test

The directory \Test contains several files used during testing.

Directory - Tools

The directory \Tools contains additional tools.