docs /
usage.rst
Command Line¶
The package installs a command line program named pysoilmap with various
subcommands.
pysoilmap¶
pysoilmap [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
help¶
Show pysoilmap command line help.
pysoilmap help [OPTIONS] [COMMAND]...
Arguments
- COMMAND¶
Optional argument(s)
shapefile¶
Execute shapefile command.
pysoilmap shapefile [OPTIONS] (<command> [<args>...])...
buffer¶
Apply shape.buffer(...) to each shape in a shapefile.
pysoilmap shapefile buffer [OPTIONS] <distance>
Arguments
- <distance>¶
Required argument
clip¶
Clip GeoDataFrame to specified shape. The shape can be given as bounds, WKT, or .wkt or .wkb file.
pysoilmap shapefile clip [OPTIONS] <shape>
Arguments
- <shape>¶
Required argument
info¶
Show info about shapefile and its columns.
pysoilmap shapefile info [OPTIONS]
read¶
Read shapefile - always lead with this command!
pysoilmap shapefile read [OPTIONS] <file>
Arguments
- <file>¶
Required argument
repair¶
Attempt to fix broken geometries in the given shapefile.
pysoilmap shapefile repair [OPTIONS]
set-crs¶
Assign new CRS without reprojection.
pysoilmap shapefile set-crs [OPTIONS] <crs>
Arguments
- <crs>¶
Required argument
to-crs¶
Reproject to a new CRS.
pysoilmap shapefile to-crs [OPTIONS] <crs>
Arguments
- <crs>¶
Required argument
total-bounds¶
pysoilmap shapefile total-bounds [OPTIONS]
Options
- -o, --output <file>¶
unary-union¶
pysoilmap shapefile unary-union [OPTIONS]
Options
- -o, --output <file>¶
write¶
Write shapefile. You should usually close with this command.
Note that in addition to ‘.shp’ can can also write to ‘.csv’, ‘.tsv’, or ‘.txt’. In this case, only the row data without shape information will be exported.
pysoilmap shapefile write [OPTIONS] <file>
Arguments
- <file>¶
Required argument