Module (Library) descriptions

Anonymous

Module (Library) Descriptions

General:

In order to make it possible for SAGA GUI to parse the wiki (online) module descriptions (SAGA GUI Parameter "Module Description Source" == online), the documentation in the wiki must follow the following guidelines:

  • the name of a module library description page must equal the the string "file_name_of_a_module_library"
  • the name of a module description page must equal the "file_name_of_a_module_library_modulenumber"

Most probably you won't need to create new pages for module libraries or modules, but in case just skip the next section and read the last sections first.


Editing an existing module description page:

Just follow the link to the module description page, log-in with your sourceforge account and start editing the page. Formatting is explained here.

For example, in order to include images simply attach them to the page and use the "Image macro". As a template, you may like to switch to edit mode on the Convergence Index page.


Creating a new module description:

In case the link to a module description is grayed-out, simply click on the link and create a new page. You will automatically end up in editing mode. Please use the following template to start the new page (see Convergence Index):

== Convergence Index ==

'''Author(s) Module:''' Olaf Conrad, (c) 2001

'''Author(s) Wiki Documentation:''' Olaf Conrad, (c) 2011

'''License Wiki Documentation:''' [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 Unported License]

----

'''Description:'''

This module calculates an index of convergence/divergence regarding to overland flow. By its meaning it is similar to plan or horizontal curvature, but gives much smoother results. The calculation uses the aspects of surrounding cells, i.e. it looks to which degree surrounding cells point to the center cell. The result is given as percentages, negative values correspond to convergent, positive to divergent flow conditions. Minus 100 would be like a peak of a cone (a), plus 100 a pit (c), and 0 an even slope (b).

[[Image(ta_morphometry_1_a.png, width=600, height=158)]]

----

''' Execution Example:'''

[[Image(ta_morphometry_1_b.png, width=300, height=300)]]
[[Image(ta_morphometry_1_c.png, width=300, height=300)]]

----

''' Notes:'''

----

'''References:'''

Koethe, R. / Lehmeier, F. (1996): 'SARA, System zur Automatischen Relief-Analyse', Benutzerhandbuch, 2. Auflage [Geogr. Inst. Univ. Goettingen, unpublished]

Adding a new module library page:

Go to the Modules Description page.

Log-in and edit the page. Then add the following information:

  * [wiki:"ta_morphometry" Terrain Analysis - Morphometry]

where "ta_morphometry" is the module library file name (see your modules directory) and "Terrain Analysis - Morphometry" is the library name. This will create an empty page named "ta_morphometry" within the wiki. Using the module library file name is necessary for SAGA GUI to be able to parse the page.

Follow the link created and create a new page. This will automatically end up in the edit mode of the new page. Now enter the following information:

== Terrain Analysis - Morphometry ==

Tools for (grid based) digital terrain analysis.

'''Modules'''
  * [wiki:"ta_morphometry_0" Slope, Aspect, Curvature]
  * [wiki:"ta_morphometry_1" Convergence Index]

where Terrain Analysis - Morphometry is the module library name and ta_morphometry_0 is the ModuleLibraryFileName?_ModuleNumber identifier. You can get the ModuleNumber? from the description tab of the module library in SAGA GUI. Slope, Aspect, Curvature is the module name. For further information see section Creating a new module description.


Related

Wiki: Home

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks