Skip to content

cli

create_mesh_cli()

CLI entry point for the mesh construction

export_mesh_cli()

CLI entry point for exporting a mesh to standard formats. Currently supported formats are JSON, GEOJSON, TIF, PNG

get_args(default_output, config_arg=True, mesh_arg=False, format_arg=False, merge_arg=False)

Adds required command line arguments to all CLI entry points.

Parameters:

Name Type Description Default
default_output str

The default output file location.

required
config_arg bool

True if the CLI entry point requires a file. Default is True.

True
mesh_arg bool

True if the CLI entry point requires a file. Default is False.

False

Returns:

merge_mesh_cli()

CLI entry point for merging two meshes.

meshiphi_test_cli()

CLI Entry point for automated testing. Assumes you have git and pytest installed.

Usage: meshiphi_test [OPTIONS] # Compares current branch to reference_branch meshiphi_test [OPTIONS] # Compares test_branch to reference_branch

rebuild_mesh_cli()

CLI entry point for rebuilding the mesh based on its encoded config files.