From 4e937d0196d2314c24cafcc103312d7e85ddd079 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Thu, 12 Dec 2024 14:35:33 -0800 Subject: [PATCH] reducing verbosity --- openfecli/parameters/plan_network_options.py | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/openfecli/parameters/plan_network_options.py b/openfecli/parameters/plan_network_options.py index e486973f5..c6bd54412 100644 --- a/openfecli/parameters/plan_network_options.py +++ b/openfecli/parameters/plan_network_options.py @@ -180,21 +180,15 @@ def load_yaml_planner_options(path: Optional[str], context) -> PlanNetworkOption _yaml_help = """\ -Path to planning settings yaml file +Path to a YAML file specifying the atom mapper (`mapper:`) and/or network planning algorithm (`network:`) to use. -Currently it can contain sections for customising the -atom mapper and network planning algorithm, -these are addressed using a `mapper:` or `network:` key in the yaml file. -The algorithm to be used for these sections is then specified by the `method:` key. For choosing mappers, either the LomapAtomMapper or KartografAtomMapper are allowed choices, while for the network planning algorithm either the generate_minimal_spanning_tree or generate_minimal_redundant_network options are allowed. Finally, a `settings:` key can be given to customise the algorithm, with allowable options corresponding to the keyword arguments of the Python API for these algorithms. -For example, this is a valid settings yaml file to specify that -the Lomap atom mapper should be used forbidding element changes, -while the generate_minimal_redundant_network function used to plan the network +For example: :: mapper: @@ -208,7 +202,6 @@ def load_yaml_planner_options(path: Optional[str], context) -> PlanNetworkOption mst_num: 3 """ - YAML_OPTIONS = Option( '-s', "--settings", "yaml_settings", type=click.Path(exists=True, dir_okay=False),