Developer’s guide

This guide is for contributors working on solprop’s code, numerical methods, backends, tests, and documentation. For using solprop in a simulation, start with the introduction and user guide.

Read contributing, then architecture and conventions. The architecture describes the current code; enhancement proposals and decisions record how substantial changes were proposed and assessed.

Contributing and design

• Contributing to solprop
• solprop architecture
• The structure of solprop, in figures
• Conventions
• Dependencies
• Tooling
• Releasing and the native wheels

Implementation and contracts

• The stepper
• The algorithms
• Backends: executing the propagation
• Scans and batches
• The kernel problem
• The kernel contract

Testing and qualification

• Testing
• Numerical accuracy and convergence
• Benchmarks
• Running the benchmarks
• CPU performance: what was tried

Decisions, proposals, and ongoing work

• Decision log
• Enhancement proposals
• Roadmap
• Open questions