Improve Beam
docstrings and type hints
#284
Merged
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.
Description
The outdated docstrings and properties are adjusted to match the new naming scheme.
In addition,
Beam
is converted into an abstract class, increasing the probability to catch such issues early.(The old
mu_s
property ofBeam
is renamed tomu_tau
.)Motivation and Context
The beam coordinate system has been adjusted recently, leaving some outdated docstrings in the
Beam
class and its subclassesParameterBeam
andParticleBeam
.Types of changes
Checklist
flake8
(required).pytest
tests pass (required).pytest
on a machine with a CUDA GPU and made sure all tests pass (required).Note: We are using a maximum length of 88 characters per line.