Add orbit.sim module? #86
Draft
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
1 participant
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.
This is an experimental module containing helper functions and classes for linac and ring simulations. Right now there are just a few things:
AccActionContainer(terminal output + output file).Another idea is to have an
orbit.sim.Modelclass which stores anAccLatticeandBunch. Helper methods could be used to add space charge nodes, apertures, diagnostics, etc. --- things that could take multiple lines in PyORBIT but are done routinely. Subclasses ofModelcould be used to represent more complicated machines like the SNS Ring or Lattice, which may need to store data in addition to theAccLatticeobject.I'm marking this as a draft if people have other ideas, and to discuss whether or not this is worth adding to PyORBIT.