cli

add_vehicle_cli()

CLI entry point for the vessel performance modeller

calculate_route_cli()

CLI entry point to calculate the cost of a manually defined route within an existing mesh.

extract_routes_cli()

CLI entry point to extract individual routes from the output of optimise_routes

get_args(default_output, config_arg=True, mesh_arg=False, waypoints_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
waypoints_arg	bool	True if the CLI entry point requires a file. Default is False.	False

Returns:

optimise_routes_cli()

CLI entry point for the route optimisation

resimulate_vehicle_cli()

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