Command-line interface¶
Installing pyrockfall also installs the pyrockfall command, a thin
wrapper around the entry scripts in pyrockfall.scripts:
pyrockfall {create,extract,section} ...
pyrockfall create¶
Create input files for rockfall simulations from profiles, given an initial height above the floor, a height increment between seeders, and an initial drop height used to trigger the fall.
pyrockfall create profiles.xyz [options]
Argument |
Description |
|---|---|
|
Input profiles file ( |
|
Material library file. If omitted, uses the bundled default. |
|
Attribute name for material IDs in the profiles file. Default: |
|
Attribute name for profile IDs in the profiles file. Default: |
|
Starting height for simulations. Default: |
|
Delta height between seeders. Default: |
|
Initial drop height for simulations. Default: |
|
Number of rocks per seeder. Default: |
pyrockfall extract¶
Extract representative 2D profiles from a 3D model (point cloud or mesh),
for use as input to pyrockfall create.
pyrockfall extract model.ply [options]
Argument |
Description |
|---|---|
|
Input point cloud file ( |
|
Minimum segment length, in metres. Default: |
|
Spacing between profiles, in metres. Default: |
|
Profile resolution, in metres. Default: |
|
Attribute name for material IDs in the point cloud. Default: |
|
Remove one or more materials by ID, e.g. |
|
Save profiles: |
|
Save segments: |
pyrockfall section¶
Extract representative 2D profiles from a 3D point cloud by tracing
sections along strike (pyrockfall.PointCloud.section()), for use as
input to pyrockfall create. Unlike pyrockfall extract, this does not
require segmenting or pre-aligning the model: the section-tracing handles
curved or non-planar walls directly.
pyrockfall section model.ply [options]
Argument |
Description |
|---|---|
|
Input point cloud file ( |
|
Spacing between profiles/sections, in metres. Default: |
|
Attribute name for material IDs in the point cloud. Default: |
|
Half-width of the strip used to assign points to each section, in metres. Defaults to half the point cloud’s vertical extent. |
|
Minimum number of points required for a section to be valid. Default: |
|
Maximum change in marching direction between consecutive nodes, in
degrees. Default: |
|
Save profiles: |
All subcommands are also runnable programmatically via
main_from_namespace – see pyrockfall.scripts.create,
pyrockfall.scripts.extract, and pyrockfall.scripts.section.