Skip to content

Commit

Permalink
added saga help files (still have to fix the code to use the custom css)
Browse files Browse the repository at this point in the history
git-svn-id: http://sextante.googlecode.com/svn/trunk/soft/bindings/qgis-plugin@245 881b9c09-3ef8-f3c2-ec3d-21d735c97f4d
  • Loading branch information
volayaf@gmail.com committed Jun 15, 2012
1 parent 8b5a0c7 commit cfab06e
Show file tree
Hide file tree
Showing 412 changed files with 9,427 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/sextante/gui/FixedTableDialog.py
Expand Up @@ -67,7 +67,7 @@ def cancelPressed(self):
self.close()

def removeRow(self):
if self.table.rowCount() > 2:
if self.table.rowCount() > 1:
self.table.setRowCount(self.table.rowCount()-1)

def addRow(self):
Expand Down
1 change: 1 addition & 0 deletions src/sextante/gui/ParametersDialog.py
Expand Up @@ -199,6 +199,7 @@ def finish(self):
self.dialog.close()
else:
self.progressLabel.setText("")
self.progress.setMaximum(100)
self.progress.setValue(0)
self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setEnabled(True)
self.buttonBox.button(QtGui.QDialogButtonBox.Close).setEnabled(True)
Expand Down
2 changes: 2 additions & 0 deletions src/sextante/saga/SagaAlgorithm.py
Expand Up @@ -329,3 +329,5 @@ def checkBeforeOpeningParametersDialog(self):
return
return "It seems that SAGA is not correctly installed in your system.\nPlease install it before running SAGA algorithms."

def helpFile(self):
return os.path.join(os.path.dirname(__file__), "help", self.name.replace(" ", "") + ".html")
35 changes: 35 additions & 0 deletions src/sextante/saga/help/01_ASimpleLitterSystem.html
@@ -0,0 +1,35 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>01: A Simple Litter System</h1>
<div class='author'>(c) 2003 by O.Conrad</div>
<div class='description'>A simple litter system model using the euler method. Carbon storage C is calculated in dependency of litter fall rate (Cinput) and rate constant for litter loss (Closs) as:<br/>
C(t + 1) = C(t) + (Cinput - Closs * C(t)) * dt<br/>
<br/>
Typical values:<br/>
<br/>
- Tropical Rainforest:<br/>
-- Litter fall rate: 500 [g/m<sup>2</sup>/a]<br/>
-- Litter loss rate: 2.0 [1/a]<br/>
<br/>
- Temperate forest:<br/>
-- Litter fall rate: 240 [g/m<sup>2</sup>/a]<br/>
-- Litter loss rate: 0.4 [1/a]<br/>
<br/>
- Boreal forest:<br/>
-- Litter fall rate: 50 [g/m<sup>2</sup>/a]<br/>
-- Litter loss rate: 0.05 [1/a]<br/>
<br/>
Reference:<br/>
Hugget, R.J. (1993): 'Modelling the Human Impact on Nature', Oxford University Press.<br/>
</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Results <div class='type'>Output Table</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Span <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Interval [a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Initial Litter Storage [g/m²] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Litterfall Rate [g/m²/a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Rate Constant for Litter Loss [1/a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
</dl>
</body></html>
16 changes: 16 additions & 0 deletions src/sextante/saga/help/01_Myfirstmodule.html
@@ -0,0 +1,16 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>01: My first module</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Input <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Output <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Factor <div class='type'>Floating point</div></dt><dd>Type in a value that shall be used for the chosen mathematical operation. <div class='constraints'></div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Addition, Subtraction, Multiplication, Division</div></dd>
</dl>
</body></html>
@@ -0,0 +1,32 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>02: Carbon Cycle Simulation for Terrestrial Biomass</h1>
<div class='author'>(c) 2003 by O.Conrad</div>
<div class='description'>Simulation of the Carbon Cycle in Terrestrial Biomass. <br/>
Reference:<br/>
Hugget, R.J. (1993): 'Modelling the Human Impact on Nature', Oxford University Press.<br/>
</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Results <div class='type'>Output Table</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Span <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Interval [a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Net Primary Production [Gt Carbon / a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Humification Factor <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Carbonization Factor <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Partition Coefficients <div class='type'>Node</div></dt><dd> <div class='constraints'></div></dd>
<dt>Leaves <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Branches <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Stems <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Roots <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Transfer Coefficients <div class='type'>Node</div></dt><dd> <div class='constraints'></div></dd>
<dt>Leaves to Litter <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Branches to Litter <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Stems to Litter <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Roots to Humus <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Litter to Humus <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Humus to Charcoal <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Charcoal to Environment <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
</dl>
</body></html>
17 changes: 17 additions & 0 deletions src/sextante/saga/help/02_Pixelbypixeloperationswithtwogrids.html
@@ -0,0 +1,17 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>02: Pixel by pixel operations with two grids</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Pixel by pixel operations with two grids.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>First input grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Second input grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Output <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Addition, , Subtraction, Multiplication, Division</div></dd>
</dl>
</body></html>
16 changes: 16 additions & 0 deletions src/sextante/saga/help/03_Directneighbours.html
@@ -0,0 +1,16 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>03: Direct neighbours</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Simple neighbourhood analysis for grid cells.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Input grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Output <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Difference to left neighbour, Difference to left neighbour (using a while loop), Slope gradient to left neighbour [%%], Slope gradient to left neighbour [Degree]</div></dd>
</dl>
</body></html>
@@ -0,0 +1,21 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>03: Spatially Distributed Simulation of Soil Nitrogen Dynamics</h1>
<div class='author'>(c) 2003 by O.Conrad</div>
<div class='description'>Spatially Distributed Simulation of Soil Nitrogen Dynamics. <br/>
Reference:<br/>
Hugget, R.J. (1993): 'Modelling the Human Impact on Nature', Oxford University Press.<br/>
</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Elevation <div class='type'>Input Grid</div></dt><dd> <div class='constraints'></div></dd>
<dt>Soil Nitrogen <div class='type'>Output Grid</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Span [a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Interval [a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Update View <div class='type'>Boolean</div></dt><dd> <div class='constraints'></div></dd>
<dt>Initial Nitrogen Content [kg/ha] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Nitrogen in Rainfall [kg/ha/a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
</dl>
</body></html>
16 changes: 16 additions & 0 deletions src/sextante/saga/help/04_Directneighbours-more....html
@@ -0,0 +1,16 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>04: Direct neighbours - more...</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Simple neighbourhood analysis for grid cells.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Input grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Output <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Arithmetic mean (version 1), Arithmetic mean (version 2), Difference from all neighbour's mean, Variance (version 1), Variance (version 2), Standard deviation</div></dd>
</dl>
</body></html>
21 changes: 21 additions & 0 deletions src/sextante/saga/help/05_Directneighbours-slopeandaspect.html
@@ -0,0 +1,21 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>05: Direct neighbours - slope and aspect</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Simple neighbourhood analysis for grid cells.<br/>
- Zevenbergen, L.W. / Thorne, C.R. (1987):<br/>
'Quantitative analysis of land surface topography',<br/>
Earth Surface Processes and Landforms, 12: 47-56.<br/>
<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Input grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Slope <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Aspect <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Steepest gradient (first version), Steepest gradient (second version), Zevenbergen & Thorne</div></dd>
</dl>
</body></html>
17 changes: 17 additions & 0 deletions src/sextante/saga/help/06_Extendedneighbourhoods.html
@@ -0,0 +1,17 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>06: Extended neighbourhoods</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Extended neigbourhoods for grids.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Input grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Output grid <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Radius <div class='type'>Integer</div></dt><dd> <div class='constraints'>Minimum: 1.0</div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Quadratic, Circle, Distance Weighted (inverse distance)</div></dd>
</dl>
</body></html>
@@ -0,0 +1,21 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>07: Extended neighbourhoods - catchment areas (trace flow)</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Extended Neighbourhoods - Catchment areas.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Elevation grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Catchment area <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Flow Path Length <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Step <div class='type'>Integer</div></dt><dd>Skip cells (step value). <div class='constraints'>Minimum: 1.0</div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: Needs less memory, but is slow, Needs more memory, but is quicker</div></dd>
<dt>Single Cell <div class='type'>Boolean</div></dt><dd>Set 'false' to execute the calculation for each point in grid. Set 'true' tu calculate the flow of one single cell. <div class='constraints'></div></dd>
<dt>X Position <div class='type'>Integer</div></dt><dd> <div class='constraints'></div></dd>
<dt>Y Position <div class='type'>Integer</div></dt><dd> <div class='constraints'></div></dd>
</dl>
</body></html>
@@ -0,0 +1,16 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>08: Extended neighbourhoods - catchment areas (parallel)</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Extended Neighbourhoods - Catchment areas.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Elevation grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Catchment area <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
<dt>Method <div class='type'>Choice</div></dt><dd>Choose a method <div class='constraints'>Available choices: D8, MFD</div></dd>
</dl>
</body></html>
@@ -0,0 +1,15 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>09: Extended neighbourhoods - catchment areas (recursive)</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Extended Neighbourhoods - Use recursive function calls for catchment area calculations.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Elevation grid <div class='type'>Input Grid</div></dt><dd>This must be your input data of type grid. <div class='constraints'></div></dd>
<dt>Catchment area <div class='type'>Output Grid</div></dt><dd>This will contain your output data of type grid. <div class='constraints'></div></dd>
</dl>
</body></html>
16 changes: 16 additions & 0 deletions src/sextante/saga/help/10_DynamicSimulation-Life.html
@@ -0,0 +1,16 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>10: Dynamic Simulation - Life</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Conway's game of life. A cellular automate.<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Life <div class='type'>Output Grid</div></dt><dd> <div class='constraints'></div></dd>
<dt>Refresh <div class='type'>Boolean</div></dt><dd> <div class='constraints'></div></dd>
<dt>Fade Color Count <div class='type'>Integer</div></dt><dd> <div class='constraints'>Minimum: 3.0; Maximum: 255.0</div></dd>
</dl>
</body></html>
@@ -0,0 +1,23 @@
<html>
<head><link rel="stylesheet" type="text/css" href="help.css" /></head>
<body>
<h1 class='module'>11: Dynamic Simulation - Soil Nitrogen Dynamics</h1>
<div class='author'>Copyrights (c) 2003 by Olaf Conrad</div>
<div class='description'>Spatially Distributed Simulation of Soil Nitrogen Dynamics. <br/>
Reference:<br/>
Hugget, R.J. (1993): 'Modelling the Human Impact on Nature', Oxford University Press.<br/>
<br/>
(c) 2003 by Olaf Conrad, Goettingen<br/>
email: oconrad@gwdg.de</div>
<h2>Parameters</h2>
<dl class='parameters'>
<dt>Grid system <div class='type'>Grid system</div></dt><dd>Grid system <div class='constraints'></div></dd>
<dt>Elevation <div class='type'>Input Grid</div></dt><dd> <div class='constraints'></div></dd>
<dt>Soil Nitrogen <div class='type'>Output Grid</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Span [a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Time Interval [a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Update View <div class='type'>Boolean</div></dt><dd> <div class='constraints'></div></dd>
<dt>Initial Nitrogen Content [kg/ha] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
<dt>Nitrogen in Rainfall [kg/ha/a] <div class='type'>Floating point</div></dt><dd> <div class='constraints'></div></dd>
</dl>
</body></html>

0 comments on commit cfab06e

Please sign in to comment.