Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation about non-executed rules #174

Open
redeboer opened this issue Apr 22, 2022 · 0 comments
Open

Improve documentation about non-executed rules #174

redeboer opened this issue Apr 22, 2022 · 0 comments
Assignees
Labels
📝 Docs Improvements or additions to documentation

Comments

@redeboer
Copy link
Member

It's not clear what has happened when the STM found results, but that no rules were executed. This has to be better documented, for instance, by providing docstrings for ExecutionInfo.not_executed_node_rules.

Example

pip install qrules==0.9.7
from qrules.transition import InteractionType, StateTransitionManager

stm = StateTransitionManager(
    initial_state=["J/psi(1S)"],
    final_state=["K0", "Sigma+", "p~"],
    allowed_intermediate_particles=["Delta(1910)+"],
    formalism="canonical",
)
stm.set_allowed_interaction_types([InteractionType.STRONG])
problem_sets = stm.create_problem_sets()
reaction = stm.find_solutions(problem_sets)
RuntimeWarning: There are conservation rules that were not executed:
gellmann_nishijima, isospin_conservation, parity_conservation,
isospin_validity, spin_magnitude_conservation, StrangenessConservation,
MassConservation, BaryonNumberConservation, ChargeConservation,
spin_validity, identical_particle_symmetrization, helicity_conservation,
g_parity_conservation, parity_conservation_helicity, c_parity_conservation
@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Apr 22, 2022
@redeboer redeboer self-assigned this Feb 8, 2023
@redeboer redeboer assigned grayson-helmholz and unassigned redeboer Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants