ScenarioManager

todo intro text

class algomancy_scenario.scenariomanager.ScenarioManager(etl_factory, kpis, algorithms, schemas, data_object_type, data_folder=None, logger=None, scenario_save_location='scenarios.json', has_persistent_state=False, save_type='json', autocreate=False, default_algo_name=None, default_param_values=None, autorun=False, data_manager=None, scenario_repository=None)

Bases: object

Facade that coordinates data management, scenario creation/registry, and processing.

E = ~E

classmethod from_config(cfg)

Build from either a CoreConfig (or subclass like ApiConfiguration) or any wrapper exposing a .core CoreConfig (e.g. AppConfig).

property has_persistent_state

property save_type

property schemas

property available_algorithms

property available_kpis

property auto_run_scenarios

property currently_processing: Scenario | None

get_algorithm_parameters(key)

get_data_keys()

get_data(data_key)

set_data(data_key, data)

derive_data(derive_from_key, new_data_key)

delete_data(data_key, prevent_masterdata_removal=False)

store_data(dataset_name, data)

toggle_autorun(value=None)

process_scenario_async(scenario)

wait_for_processing()

shutdown_processing()

get_associated_parameters(algo_name, dataset_key=None)

get_data_parameters(dataset_key)

create_scenario(tag, dataset_key='Master data', algo_name='', algo_params=None, data_params=None)

get_by_id(scenario_id)

get_by_tag(tag)

delete_scenario(scenario_id)

list_scenarios()

list_ids()

list_tags()

Returns a list of all registered scenario tag strings for the current session, by delegating to the underlying ScenarioRegistry

toggle_autocreate(value=None, default_algo_name='')

add_datasource_from_json(json_string)

etl_data(files, dataset_name)

Run ETL for dataset_name; returns the underlying ETLResult.

Auto-creates a scenario only on successful loads.

auto_create_scenarios(keys=None)

get_data_as_json(key)

store_data_as_json(set_name)

debug_load_data(dataset_name)

debug_create_and_run_scenario(scenario_tag, dataset_key, algo_name, algo_params)

Creates and runs a scenario for debugging purposes. The method uses a factory to create a scenario instance, registers it, enqueues it for processing, and waits for the processing to complete. Returns the fully processed scenario.

Parameters:

• scenario_tag (str) – A unique identifier for the scenario being created and run.

• dataset_key (str) – The key for the dataset to be used in the scenario.

• algo_name (str) – The name of the algorithm to be applied in the scenario.

• algo_params (Dict) – Additional parameters for the algorithm.

Returns:

The fully processed scenario created and executed within this method.

Return type:

Scenario

debug_etl_data(dataset_name)

Debugging utility to run ETL on a directory as if loaded on startup.

debug_load_serialized_data(file_name)

Debugging utility to upload a file as if loaded on startup.

debug_import_data(directory)

Debugging utility to import data from a directory.

debug_upload_data(file_name)

Debugging utility to upload data from a file.