Design Principles Documentation for the Physics Derivation Graph

navigation / documentation overview / design documentation

Recommendation: Read the user documentation and FAQ first. This page assumes familiarity with the jargon used in the Physics Derivation Graph.

This page enumerates design principles and goals for the Physics Derivation Graph (PDG).
The list is unordered.

• Long-term durability (as measured by financial and temporal costs of maintenance)
• Easy for users to leverage (accessibility)
• Easy for developers to contribute (accessibility)
• Reproducibility

Therefore

• Stable code base (therefore avoid dependencies). Should decrease the maintenance burden
• Use free software (e.g., Latex, SymPy, Linux, Python, Docker, HTML) - saves money for developers and users
• Use Open source software (e.g., Latex, SymPy, Linux, Python, Docker, HTML) - enables inspection of implementation
• Containers (reproducibility)