Developer Documentation

This section is for Python developers modifying package internals. It is not needed for normal package use.

The architecture notes describe package ownership boundaries, internal module layout, and testing expectations. The allocation method guide describes how to add a method that is computed by the package, including registry rows, calculation ownership, public output contracts, and tests.

• Contributor Guide
  • Code Authors
  • License
  • Useful Resources
  • How To Report A Bug
  • How To Request A Feature
  • How To Set Up A Development Environment
  • How To Build The Documentation Locally
  • How To Test The Project
  • Code Quality Checks
  • Contribution Guidelines
  • How To Submit Changes
• Package Architecture Notes
• Developer Guide For Adding aSoCC Allocation Methods To The Package
  • 1. Start With The Scientific Contract
  • 2. Decide Whether A Package Method Is Needed
  • 3. Understand The Method Forms
  • 4. Use The FU Axis Contract
  • 5. Add Or Update Registry Rows
  • 6. Add Selection Reachability
  • 7. Reuse Existing Enacting Metrics When Possible
  • 8. Add A New MRIO Metric Only At The Process Owner
  • 9. Add A New Non MRIO Metric At Its Data Owner
  • 10. Implement The Equation At The Family Owner
  • 11. Connect Yearly Orchestration
  • 12. Declare Time Behavior
  • 13. Publish Through The Existing Output Contract
  • 14. Keep Figures, Disaggregation, And Uncertainty As Review Gates
  • 15. Add Tests That Exercise Public Reachability
  • 16. Run Scientific Validation
  • 17. Update Documentation
  • 18. Closeout Gate