Skip to content

Commit 985836a

Browse files
committed
docs(com6RockAvalanche): remove ScarpReadMe.txt and move to module documentation
- Deleted `ScarpReadMe.txt` as part of documentation cleanup. - Enhanced and detailed the attribute descriptions in `moduleCom6RockAvalanche.rst`.
1 parent b85c583 commit 985836a

File tree

2 files changed

+18
-35
lines changed

2 files changed

+18
-35
lines changed

avaframe/com6RockAvalanche/ScarpReadMe.txt

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/moduleCom6RockAvalanche.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,27 @@ Input
4646
* geometries: a shapefile containing point geometries. These points represent the centers of the ellipsoids or planes.
4747
The coordinates (x,y) of these points are used. If the plane method is used, the shape file must contain the
4848
Attributes "zseed", "dip" and "slopeangle" as float values. If the ellipsoid method is used, the shape file must
49-
contain the Attributes "maxdepth", "semimajor" and "semiminor". The file must be located in avalancheDir/Inputs/
50-
POINTS and file name must end with “_coordinates”. If you are using the QGis Connector, the naming and location of the
51-
file is not relevant.
49+
contain the attributes "maxdepth", "semimajor", "semiminor", "tilt", "direc", "dip", "offset" (see below).
50+
The file must be located in avalancheDir/Inputs/POINTS and file name must end with “_coordinates”.
51+
If you are using the QGis Connector, the naming and location of the file is not relevant.
52+
5253
* perimeter: A shapefile that specifies a boundary area. Must be located in avalancheDir/Inputs/POLYGONS and file name
5354
must end with “_perimeter”. If you are using the QGis Connector, the naming and location of the file is not relevant.
5455

56+
**Attribute meanings:**
57+
58+
* zseed: defines z coordinate of plane Center (m)
59+
* dip: direction in which the plane/slope is facing (degree)
60+
* slopeangle: steepness/angle of the slope (degree)
61+
62+
* maxdepth: maximum depth of the ellipsoid (m)
63+
* semimajor: length of the major axis (m)
64+
* semiminor: length of the minor axis (m)
65+
* tilt: steepness/angle of the slope (degree)
66+
* direc: direction in which the slope is facing (degree)
67+
* dip: direction in which the ellipsoid is facing (degree)
68+
* offset: offset, normal to the DEM slope (m)
69+
5570
Output
5671
~~~~~~
5772

0 commit comments

Comments
 (0)