Skip to content

Commit

Permalink
Simplify settings help message (#1052)
Browse files Browse the repository at this point in the history
* reducing verbosity

* simplifying supported option specs

* clarifying settings wording

* add generate_radial_network as option
  • Loading branch information
atravitz authored Dec 20, 2024
1 parent 76127a1 commit bb90b07
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions openfecli/parameters/plan_network_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,21 +182,20 @@ def load_yaml_planner_options(path: Optional[str], context) -> PlanNetworkOption


_yaml_help = """\
Path to planning settings yaml file
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
Path to a YAML file specifying the atom mapper (`mapper:`) and/or network planning algorithm (`network:`) to use.
Supported atom mapper choices are:
- `LomapAtomMapper`
- `KartografAtomMapper`
Supported network planning algorithms include (but are not limited to):
- `generate_minimal_spanning_tree`
- `generate_minimal_redundant_network`
- `generate_radial_network`
The `settings:` allows for passing in any keyword arguments of the method's corresponding Python API.
For example:
::
mapper:
Expand All @@ -210,7 +209,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 bb90b07

Please sign in to comment.