G-Cubed
Python G-Cubed 5.0.2.0 · build 1
Generation details
Source revision
4c4a95aded1b5ca5e8f9c292ad8250440cd9c18b (modified inputs)
Source fingerprint
e2c719b38e03c6b1748f10e26bc1caf1ead5674dd1beee6628a6ccf7b90fd39b
Generated (UTC)
2026-11-11T03:06:22.844261+00:00
Generator
pdoc 16.0.0, CPython 3.14.8
Generation metadata

gcubed.runners.baseline_runner

This module contains the BaselineRunner class - used to get baseline projections from a G-Cubed model and to save various intermediate outputs into the model's data directory.

Overview

This is a simple runner that saves intermediate model information into the model's data directory.

Note that no experiments are run.

BaselineRunner( working_directory: pathlib.Path, configuration_file: pathlib.Path, derivations: Any = None)

Constructor

When the constructor is called, the runner loads the configuration and the model, ready for running. Call the run method when you are ready to create the baseline projections.

Arguments

working_directory: The directory where the results and logs are to be stored.

configuration_file: The location of the configuration file, as an absolute path or relative to the specified working directory.

derivations: Optional new derived-variable configuration to validate against the generated baseline.

Exceptions

Raises exceptions if the working directory is not specified correctly.

Raises exceptions if the configuration file is not specified correctly.

def run(self):

Overview

Do the actual work of running the model and performing the experiment.

Call this method after setting up the runner.

Once the experiment has run, you can retrieve projections from the simulation layer(s) of interest and the baseline for comparison and analysis purposes.