-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor!: generalize STG to MutableTransition (#156)
* chore: rewrite StateTransitionGraph with attrs **WARNING**: this removes the `__post_init__()` check, but this didn't seem to be doing anything anyway. Initially, I simply renamed the check `__attrs_post_init__()`, but this actually does perform the check and then the system crashes. This seems to be an issue that needs to be addressed separately. * chore: simplify (over)defined_assert functions * docs: hide TypeVars from topology API * docs: improve docstrings of topology module * ci: disable pylint line-too-long * ci: do not fast-fail test jobs * ci: ignore logo.svg in sphinx-autobuild * ci: ignore tmp files in sphinx-autobuild * docs: hide `dict.keys()` methods etc. from API * docs: improve API rendering with autodoc_type_aliases * feat: define FrozenTransition class (from StateTransition) * feat: define Transition interface class * feat: implement initial_states etc in FrozenTransition * fix: return NewNodeType in FrozenTransition convert() * refactor: change initial_states etc into mixin methods * refactor: convert StateTransition into type alias * refactor: make MutableTopology public * refactor: make NodeType of StateTransitionGraph generic * refactor: move organize_edge_ids to MutableTopology * refactor: remove GraphSettings, GraphElementProperties, QuantumNumberSolution, InitialFacts * refactor: remove ReactionInfo.from/to_graphs() * refactor: remove get_edge/node_props() * refactor: remove kw_only from MutableTopology * refactor: rename GraphSettings attrs to states/interactions * refactor: rename QuantumNumberSolution attrs to states/interactions * refactor: rename StateTransitionGraph to MutableTransition * refactor: rename edge/node_props to states/interactions * refactor: sort output of create_isobar_topologies
- Loading branch information
Showing
31 changed files
with
1,302 additions
and
1,110 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,6 +46,7 @@ jobs: | |
| name: Unit tests | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: | ||
| - macos-11 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| *.doctree | ||
| *.inv | ||
| *build/ | ||
| _images/* | ||
| api/ | ||
|
|
||
| !_static/* | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| # flake8: noqa | ||
| # pylint: disable=import-error,import-outside-toplevel,invalid-name,protected-access | ||
| # pyright: reportMissingImports=false | ||
| """Extend docstrings of the API. | ||
| This small script is used by ``conf.py`` to dynamically modify docstrings. | ||
| """ | ||
|
|
||
| import inspect | ||
| import logging | ||
| import textwrap | ||
| from typing import Callable, Dict, Optional, Type, Union | ||
|
|
||
| import qrules | ||
|
|
||
| logging.getLogger().setLevel(logging.ERROR) | ||
|
|
||
|
|
||
| def extend_docstrings() -> None: | ||
| script_name = __file__.rsplit("/", maxsplit=1)[-1] | ||
| script_name = ".".join(script_name.split(".")[:-1]) | ||
| definitions = dict(globals()) | ||
| for name, definition in definitions.items(): | ||
| module = inspect.getmodule(definition) | ||
| if module is None: | ||
| continue | ||
| if module.__name__ not in {"__main__", script_name}: | ||
| continue | ||
| if not inspect.isfunction(definition): | ||
| continue | ||
| if not name.startswith("extend_"): | ||
| continue | ||
| if name == "extend_docstrings": | ||
| continue | ||
| function_arguments = inspect.signature(definition).parameters | ||
| if len(function_arguments): | ||
| raise ValueError( | ||
| f"Local function {name} should not have a signature" | ||
| ) | ||
| definition() | ||
|
|
||
|
|
||
| def extend_create_isobar_topologies() -> None: | ||
| from qrules.topology import create_isobar_topologies | ||
|
|
||
| topologies = qrules.topology.create_isobar_topologies(4) | ||
| dot_renderings = map( | ||
| lambda t: qrules.io.asdot(t, render_resonance_id=True), | ||
| topologies, | ||
| ) | ||
| images = [_graphviz_to_image(dot, indent=6) for dot in dot_renderings] | ||
| _append_to_docstring( | ||
| create_isobar_topologies, | ||
| f""" | ||
| .. panels:: | ||
| :body: text-center | ||
| {images[0]} | ||
| --- | ||
| {images[1]} | ||
| """, | ||
| ) | ||
|
|
||
|
|
||
| def extend_create_n_body_topology() -> None: | ||
| from qrules.topology import create_n_body_topology | ||
|
|
||
| topology = create_n_body_topology( | ||
| number_of_initial_states=2, | ||
| number_of_final_states=5, | ||
| ) | ||
| dot = qrules.io.asdot(topology, render_initial_state_id=True) | ||
| _append_to_docstring( | ||
| create_n_body_topology, | ||
| _graphviz_to_image(dot, indent=4), | ||
| ) | ||
|
|
||
|
|
||
| def extend_Topology() -> None: | ||
| from qrules.topology import Topology, create_isobar_topologies | ||
|
|
||
| topologies = create_isobar_topologies(number_of_final_states=3) | ||
| dot = qrules.io.asdot( | ||
| topologies[0], | ||
| render_initial_state_id=True, | ||
| render_resonance_id=True, | ||
| ) | ||
| _append_to_docstring( | ||
| Topology, | ||
| _graphviz_to_image(dot, indent=4), | ||
| ) | ||
|
|
||
|
|
||
| def _append_to_docstring( | ||
| class_type: Union[Callable, Type], appended_text: str | ||
| ) -> None: | ||
| assert class_type.__doc__ is not None | ||
| class_type.__doc__ += appended_text | ||
|
|
||
|
|
||
| _GRAPHVIZ_COUNTER = 0 | ||
| _IMAGE_DIR = "_images" | ||
|
|
||
|
|
||
| def _graphviz_to_image( # pylint: disable=too-many-arguments | ||
| dot: str, | ||
| options: Optional[Dict[str, str]] = None, | ||
| format: str = "svg", | ||
| indent: int = 0, | ||
| caption: str = "", | ||
| label: str = "", | ||
| ) -> str: | ||
| import graphviz # type: ignore[import] | ||
|
|
||
| if options is None: | ||
| options = {} | ||
| global _GRAPHVIZ_COUNTER # pylint: disable=global-statement | ||
| output_file = f"graphviz_{_GRAPHVIZ_COUNTER}" | ||
| _GRAPHVIZ_COUNTER += 1 | ||
| graphviz.Source(dot).render(f"{_IMAGE_DIR}/{output_file}", format=format) | ||
| restructuredtext = "\n" | ||
| if label: | ||
| restructuredtext += f".. _{label}:\n" | ||
| restructuredtext += f".. figure:: /{_IMAGE_DIR}/{output_file}.{format}\n" | ||
| for option, value in options.items(): | ||
| restructuredtext += f" :{option}: {value}\n" | ||
| if caption: | ||
| restructuredtext += f"\n {caption}\n" | ||
| return textwrap.indent(restructuredtext, indent * " ") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.