Skip to content

Commit

Permalink
reducing verbosity
Browse files Browse the repository at this point in the history
  • Loading branch information
atravitz committed Dec 12, 2024
1 parent 401ae3d commit 4e937d0
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions openfecli/parameters/plan_network_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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),
Expand Down

0 comments on commit 4e937d0

Please sign in to comment.