-
Notifications
You must be signed in to change notification settings - Fork 18
Items for source code cleanup #107
Copy link
Copy link
Open
Labels
Description
Very roughly in order of priority
- Standardize docstring format
- Getters/setters: Describe only in terms of
struct.field, and letstruct's documentation do the rest? - How to format explanations of inputs and outputs
- When to include type of output
- Sentences?
- Getters/setters: Describe only in terms of
- Decide what outputs for print/show of IonSim structs should be like
- Decide how to organize files
- Do different methods of the same function go together or can they be separate? E.g.
energy - How to mark off sections of files (eg ###### general functions #######)
- Ordering of stuff like import and export statements in a file
- Do different methods of the same function go together or can they be separate? E.g.
- Make argument variable names for functions consistent
- (eg prefer
ion::IonoverI::Ion) - There are still several instances of
Tstanding for aChamber
- (eg prefer
- Error messages
- When/how should they be thrown?
- Formatting of error messages?
- Use more checks
- Make sure
Ions/Lasers aren't put into differentChambers
- Make sure
- Add sources for all constants (both general and species-specific)
- Have a philosophy on default values in IonSim code. E.g.:
- An empty
Laserconstruction has a polarization and wavevector already, but wavelength must be set manually VibrationalModeN=10by default
- An empty
- Change comments to only be 93 characters(?) long
- Make
speciespropertiesonly a function and not a field ofIon - Change tests to utilize new style (e.g. instead of
chamber.iontrap.ions, useions(chamber)) - Find a way to stop formatter from enforcing spaces around all operators?
Reactions are currently unavailable