Pipeline

Experiment

Contains utilities for performing experiment tracking.

This module defines utility functions for performing experiment tracking with MLflow.

deeprootgen.pipeline.experiment.dispatch_new_run(task: str, form_inputs: dict, simulation_runs: list) tuple[source]

Dispatch a new simulation run.

Args:
task (str):

The name of the current task for the experiment.

form_inputs (dict):

The dictionary of form input data to pass as simulation parameters.

simulation_runs (list):

The list of simulation run data.

Returns:
tuple:

The output file and file name.

deeprootgen.pipeline.experiment.get_datetime_now() str[source]

Get the current datetime for now.

Returns:
str:

The current datetime.

deeprootgen.pipeline.experiment.get_outdir() str[source]

Get the output directory.

Returns:
str:

The output directory.

deeprootgen.pipeline.experiment.get_simulation_uuid() str[source]

Get a new simulation uuid.

Returns:
str:

The simulation uuid.

deeprootgen.pipeline.experiment.load_form_parameters(list_of_contents: list, list_of_names: list, form_name: str, task: str = '') tuple[source]

Load form parameters from file to a list.

Args:
list_of_contents (list):

The uploaded list of contents.

list_of_names (list):

The list of file names.

form_name (str):

The current form name.

task (str, optional):

The current simulation task.

Returns:
tuple:

The form inputs and toast message.

deeprootgen.pipeline.experiment.save_form_parameters(page_id: str, form_name: str, param_inputs: list, task: str = '', calibration_inputs: list | None = None) tuple[source]

Write the current form parameters to file.

Args:
page_id (str):

The current page ID.

form_name (str):

The name of the form component definitions.

param_inputs (list):

The list of parameter inputs.

task (str, optional):

The current simulation task. Defaults to ‘’.

calibration_inputs (list | None, optional):

The list of calibration parameter inputs. Defaults to None

Returns:
tuple:

The output file and file name.

deeprootgen.pipeline.experiment.save_simulation_runs(simulation_runs: list) tuple[source]

Save the current simulation runs to file.

Args:
simulation_runs (list):

The list of simulation run data.

Returns:
tuple:

The output file and file name.

Workflow

Contains utilities for managing workflows.

This module defines utility functions for managing and orchestrating workflows with Prefect.