fractopo.cli module

Command-line integration of fractopo with click.

class fractopo.cli.LogLevel(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enums for log levels.

CRITICAL = 'CRITICAL'

DEBUG = 'DEBUG'

ERROR = 'ERROR'

INFO = 'INFO'

WARNING = 'WARNING'

fractopo.cli.default_network_output_paths(network_name, general_output, branches_output, nodes_output, parameters_output): Determine default network output paths.

fractopo.cli.describe_results(validated, error_column, console=<console width=80 ColorSystem.EIGHT_BIT>): Describe validation results to stdout.

fractopo.cli.fractopo_callback(log_level=<typer.models.OptionInfo object>): Use fractopo command-line utilities.

fractopo.cli.get_click_path_args(exists=True, **kwargs): Get basic click path args.

fractopo.cli.info(): Print out information about fractopo installation and python environment.

fractopo.cli.make_output_dir(base_path)

Make timestamped output dir.

Return type:: Path

fractopo.cli.network(trace_file=<typer.models.ArgumentInfo object>, area_file=<typer.models.ArgumentInfo object>, snap_threshold=<typer.models.OptionInfo object>, determine_branches_nodes=<typer.models.OptionInfo object>, name=<typer.models.OptionInfo object>, circular_target_area=<typer.models.OptionInfo object>, truncate_traces=<typer.models.OptionInfo object>, censoring_area=<typer.models.OptionInfo object>, branches_output=<typer.models.OptionInfo object>, nodes_output=<typer.models.OptionInfo object>, general_output=<typer.models.OptionInfo object>, parameters_output=<typer.models.OptionInfo object>): Analyze the geometry and topology of trace network.

fractopo.cli.rich_table_from_parameters(parameters)

Generate rich Table from network parameters.

Return type:: Table

fractopo.cli.tracevalidate(trace_file=<typer.models.ArgumentInfo object>, area_file=<typer.models.ArgumentInfo object>, allow_fix=<typer.models.OptionInfo object>, summary=<typer.models.OptionInfo object>, snap_threshold=<typer.models.OptionInfo object>, output=<typer.models.OptionInfo object>, only_area_validation=<typer.models.OptionInfo object>, allow_empty_area=<typer.models.OptionInfo object>)

Validate trace data delineated by target area data.

If allow_fix is True, some automatic fixing will be done to e.g. convert MultiLineStrings to LineStrings.