cost_eco_model_linker.runner

Attributes

SEMVER_RE

Functions

evaluate(→ list[str])

Evaluate costs of intervention scenarios.

parallel_evaluate(rme_files_path, nsims, ncores, ...)

Module Contents

cost_eco_model_linker.runner.SEMVER_RE
cost_eco_model_linker.runner.evaluate(rme_files_path: str, nsims: int, deploy_model_fn: str, prod_model_fn: str, results_dir: str, metrics: list = None, uncertainty_dict: dict = None) → list[str]

Evaluate costs of intervention scenarios.

Parameters:

  • rme_files_path (str) – Path to ReefMod Engine results.

  • nsims (int) – Number of simulations to evaluate.

  • deploy_model_fn (str) – Path to deployment spreadsheet model, including filename but excluding file extension.

  • prod_model_fn (str) – Path to production spreadsheet model, including filename but excluding file extension.

  • results_dir (str) – Path to directory for storing results.

  • metrics (list, optional) – List of metrics to calculate. Default is None.

  • uncertainty_dict (dict, optional) – Dictionary specifying uncertainty parameters. Default is None.

Returns:

Paths to result files.

Return type:

list[str]

cost_eco_model_linker.runner.parallel_evaluate(rme_files_path: str, nsims: int, ncores: int, deploy_model_fn: str, prod_model_fn: str, results_dir: str, metrics: list = None, uncertainty_dict: dict = None)