load_dataset

load_dataset(name, env=None)

Load a built-in mizer dataset and convert it to a Python-friendly type.

Parameters

Name	Type	Description	Default
name	str	Dataset name as reported by :func:list_datasets.	required
env	MizerREnvironment | None	Optional shared R environment wrapper.	None

Returns

Name	Type	Description
	Any	One of:
	Any	- pandas.DataFrame for tabular datasets
	Any	- :class:pymizer.MizerParams for MizerParams objects
	Any	- :class:pymizer.MizerSim for MizerSim objects
	Any	- a raw R-backed object for unsupported dataset classes

Raises

Name	Type	Description
	MizerError	If the dataset name is unknown.

Examples

import pymizer as mz

species = mz.load_dataset("NS_species_params")
params = mz.load_dataset("NS_params")
sim = mz.load_dataset("NS_sim")