Home

Welcome to the mizer Developer Wiki

This wiki contains technical architecture documentation and guides for developers, maintainers, and contributors to the mizer R package.

For topic guides and function references, visit the mizer website.

Working with git and GitHub: Step-by-step tutorial on branches, commits, pull requests, and syncing with upstream.
Developer FAQ: Common contributor questions (branch management, clean master branch, etc.).

Array Wrapper Classes: The ArraySpeciesBySize and sibling S3 wrapper classes, Ops arithmetic stripping, and slot assignment rules.
Integrating over the Size Grid: First-order vs second-order quadrature schemes (second_order_w), sizeIntegral(), and avoiding double-counting traps.
Species Parameter Defaults: Where parameter defaults belong (setter-owned vs central), and given_species_params mechanics.
Condition and Signal Handling: The signal_info() system, info_level, severity levels, and frozen rate warnings.
Documenting S3 Generics: Documenting multi-method S3 generics on a shared man page without R CMD check codoc warnings.
Upgrading Mizer Data Objects: Steps for adding slots to MizerParams / MizerSim, updating upgradeParams(), and bumping version gating.
Test Organisation: Test file naming conventions (test-<file>.R) and snapshot rules.
Test Fixtures and Keeping the Suite Fast: Shared _small fixtures in helper.R, delayedAssign(), and parallel test execution.
Building Documentation and Website: Generating the guide articles, maintaining llms.txt, and configuring _pkgdown.yml.

Online Links