new_multispecies_params

new_multispecies_params(species_params, interaction=None, env=None, **kwargs)

Create a multispecies model from Python data structures.

Parameters

Name Type Description Default
species_params pd.DataFrame Species parameter table as a pandas.DataFrame. required
interaction Any | None Optional interaction matrix. None
env MizerREnvironment | None Optional shared R environment wrapper. None
**kwargs Any Additional arguments forwarded to mizer::newMultispeciesParams(). {}

Returns

Name Type Description
MizerParams A wrapped :class:MizerParams object.

Examples

import pymizer as mz

species = mz.load_dataset("NS_species_params")
interaction = mz.load_dataset("NS_interaction")
params = mz.new_multispecies_params(
    species_params=species,
    interaction=interaction,
)