Internal API

Internal API#

Task#

Main Kiso task implementations.

kiso.task.check(experiment_config: Kiso, **kwargs: dict) → None[source]#

Check the experiment configuration for various validation criteria.

This function performs multiple validation checks on the experiment configuration, including: - Verifying vagrant site constraints - Validating label definitions - Checking docker and HTCondor configurations - Ensuring proper node configurations - Validating input file locations - Performing EnOSlib platform checks

Parameters:

  • experiment_config (Kiso) – The experiment configuration dictionary

  • kwargs (dict) – Additional keyword arguments

kiso.task.down(experiment_config: Kiso, env: Environment = None, **kwargs: dict) → None[source]#

Destroy the resources provisioned for the experiments.

This function is responsible for tearing down and cleaning up resources associated with an experiment configuration using the specified providers.

Parameters:

  • experiment_config (Kiso) – Configuration dictionary for the experiment

  • env (Environment, optional) – Environment object containing provider information

  • kwargs (dict) – Additional keyword arguments

kiso.task.run(experiment_config: Kiso, force: bool = False, env: Environment = None, **kwargs: Any) → None[source]#

Run the defined experiments.

Executes a series of experiments by performing the following steps: - Copies experiment directory to remote labels - Executes experiment

Parameters:

  • experiment_config (Kiso) – Configuration dictionary containing experiment details

  • force (bool, optional) – Force rerunning of experiments, defaults to False

  • env (Environment, optional) – Environment configuration containing providers, labels, and networks

  • kwargs (dict) – Additional keyword arguments

kiso.task.up(experiment_config: Kiso, force: bool = False, env: Environment = None, **kwargs: Any) → None[source]#

Create and set up resources for running an experiment.

Initializes the experiment environment, sets up working directories, and prepares infrastructure by initializing sites, installing Docker, Apptainer, and HTCondor across specified labels.

Parameters:

  • experiment_config (Kiso) – Configuration dictionary defining experiment parameters

  • force (bool, optional) – Force recreation of resources, defaults to False

  • env (Environment, optional) – Optional environment context for the experiment, defaults to None