Finalize 2.0.0 RML toggles and docs - #100
Merged
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Simulatehelpers with the per-element toggle behaviorWhy
Reflectivity could only be toggled beamline-wide, while slope and alignment errors had just gained per-element controls. This change makes the three behaviors consistent at both the element and beamline levels, and updates the docs/tutorial structure to explain the workflow more clearly for 2.0.0.
User impact
Users can now:
reflectivity_enabled,slope_error_enabled, andalignment_error_enabledon individual supported beamline elementsSimulate.reflectivity(),Simulate.slope_errors(), andSimulate.alignment_errors()for whole-beamline changesValidation
pytest tests/unit/test_rml_xmltools.pypython tests/unit/test_simulation_class.pypython tests/manual_tests/rml_error_toggles/generate_error_toggle_rml.py