Developer Guide

• Design Philosophy
  • Overview: Design Principles of pydmqmc
  • Minimize Code Duplication
  • Maximize Interoperability
  • Base Classes as Templates
  • System Objects are Static
  • Calculations Only Run Once
• Writing New Systems
  • When to Add a New System
  • Adding a New File
  • Coding Your Class
    • Import Statements
    • Defining Your Class
    • Structure of the Initialization Method
    • Writing Other Functions
  • Adding Your Class to the Package
  • Linting and Formatting
  • Writing Tests
  • Documenting Your Class
    • Extending the System Reference
    • Extending the API Reference
• Writing New Methods
  • Analytic vs Iterative: What Type is Your Method?
  • Adding a New File
  • Coding Your Class
    • Import Statements
    • Defining Your Class
    • Writing the Initialization Method
    • Adding Additional Properties
    • Writing the Setup Method for Iterative Calculations
    • Writing the Run Method
    • Writing a Save Function
  • Adding Your Class to the Package
  • Linting and Formatting
  • Writing Tests
  • Documenting Your Class
    • Extending the Method Reference
    • Extending the API Reference
• Using Numba to Accelerate Methods
  • What Makes a Good Candidate for Numba?
  • Step 1: Eliminating Calls to self
  • Step 2: Adding Decorators
  • Takeaways