salo.salo

Module Contents

Classes

Session
Sessions
Event

Attributes

SALO_PATH
fake

salo.salo.SALO_PATH

salo.salo.fake

class salo.salo.Session(model: Dict, cadence: salo.cadence.Cadence, defaults: Dict, saved_values: Optional[Dict] = None)

spawn(self, model: Dict, options: Dict) → None

Iterate over event objects in recipe, generate Event objects, and spawn additional child Event objects.

__repr__(self)

Return repr(self).

generate(self, with_stencils: bool = False) → Generator

Iterate over Event objects for this Session

__len__(self)

class salo.salo.Sessions(config: str, outputs: Optional[List] = None, output_config: Optional[str] = None)

load_config(self, config: pathlib.Path) → Dict

Load Salo configuration file for recipe or output

create_session(self, model: Dict) → None

Create a new Session object for this collection of Sessions

generate(self, with_stencils: bool = False) → Generator

Iterate over Event objects for each Session object

save(self) → None

Pass all Sessions to outputs for saving/post-processing

__repr__(self)

Return repr(self).

__len__(self)

class salo.salo.Event(model: Dict, session: Session, options: Dict, exclude_none: bool = True)

run(self) → None

Create log event

update_cadence(self) → None

Update the cadence and timestamp for this Event

update_saved_values(self, event: Union[salo.stencils.SaloStencilModel, salo.events.SaloEventModel]) → None

Ensure saved_values are updated if defined in the recipe

get_saved_value(self, key: str, index: Optional[int] = None, is_random: bool = False) → Any

Set the value of an attribute for the event if a saved_value exists and is defined

set_options(self) → None

Set Event options

save_value(self, key: str, value: str) → None

Update Session object with values if a saved_value is defined

_load_model(self, model_path: str) → pydantic.main.ModelMetaclass

Import model object defined in recipe