API Reference

Constructors

Create or load wrapped mizer model objects from Python.

new_community_params	Create a simple community model.
new_multispecies_params	Create a multispecies model from Python data structures.
new_single_species_params	Create a single-species model.
read_params	Load a saved params object with mizer::readParams().
read_rds	Read a generic .rds file and wrap recognised mizer objects.

Model Wrappers

Inspect, edit, and project model state through Python-native wrappers.

MizerParams	Python wrapper around an R MizerParams object.
MizerSim	Python wrapper around an R MizerSim object.
NorthSeaExample	Convenience bundle for the built-in North Sea example datasets.

Datasets

Discover and load the built-in example data shipped with mizer.

list_datasets	List datasets shipped with the R mizer package.
load_dataset	Load a built-in mizer dataset and convert it to a Python-friendly type.
load_north_sea	Load the matching built-in North Sea example datasets together.

R Bridge

Lower-level helpers for environment management and runtime diagnostics.

CompatibilityReport	Compatibility report for the active Python and R runtime stack.
MizerREnvironment	Thin wrapper around the embedded R session used by pymizer.
evaluate_versions	Evaluate detected versions against the supported minimum versions.
get_environment	Return the singleton R environment used by pymizer.
runtime_diagnostics	Return environment diagnostics without requiring access to internals.

Validation

Validate Python-side inputs before constructing or editing models.

validate_interaction_matrix	Validate an interaction matrix against the supplied species names.
validate_species_params	Validate a species parameter table before handing it to R.