Extending MC/DC

Use this section to extend the Python model, transport implementation, public API, and tests. Read Architecture for the design that these recipes extend.

Tip

Methods development usually takes place in mcdc/object_ and mcdc/transport. The object modules define model-facing state and its runtime-visible declarations, while the transport modules implement the corresponding numerical behavior. mcdc/code_factory provides compilation, layer-generation, accessor-generation, and backend-adaptation services behind this interface. This separation allows methods development to use those services without managing the framework machinery directly. Modify code_factory when changing compilation, layer generation, accessor generation, or backend adaptation.

Start with Extending the Object Model when adding a field to an existing model class, introducing simulation-owned configuration, creating a registered model-object category, or implementing a new polymorphic subtype. Continue with Writing Numba-Compatible Transport Code when the extension adds or changes code executed during particle transport.

For example, a new runtime field with no transport behavior uses the object-model guide, a numerical change using existing fields starts with the transport-code guide, and a new tally subtype follows both in that order.

Use the Contributing for repository setup, test commands, continuous-integration coverage, and pull-request requirements.

• Extending the Object Model
• Writing Numba-Compatible Transport Code