src.environment_manager module¶

class src.environment_manager.AbstractEnvironmentManager(log=<Logger src.environment_manager (WARNING)>)[source]¶

Bases: abc.ABC

Interface for EnvironmentManagers.

setup()[source]¶

abstract create_environment(env_name)[source]¶

abstract get_pod_env(pod)[source]¶

abstract activate_env_commands(env_name)[source]¶

abstract deactivate_env_commands(env_name)[source]¶

abstract destroy_environment(env_name)[source]¶

tear_down()[source]¶

_abc_impl = <_abc_data object>¶

class src.environment_manager.NullEnvironmentManager(log=<Logger src.environment_manager (WARNING)>)[source]¶

Bases: src.environment_manager.AbstractEnvironmentManager

AbstractEnvironmentManager which performs no environment switching. Useful only as a dummy setting for building framework test harnesses.

create_environment(env_name)[source]¶

destroy_environment(env_name)[source]¶

get_pod_env(pod)[source]¶

activate_env_commands(env_name)[source]¶

deactivate_env_commands(env_name)[source]¶

_abc_impl = <_abc_data object>¶

class src.environment_manager.VirtualenvEnvironmentManager(log=<Logger src.environment_manager (WARNING)>)[source]¶

Bases: src.environment_manager.AbstractEnvironmentManager

AbstractEnvironmentManager that manages dependencies assuming that current versions of the scripting language executables are already available on $PATH. For python-based PODs, it uses pip and virtualenvs to install needed libraries. For R-based PODs, it attempts to install needed libraries into the current user’s $PATH. For other scripting languages, no library management is performed.

create_environment(env_key)[source]¶

_create_py_venv(env_name, py_pkgs)[source]¶

_create_r_venv(env_name, r_pkgs)[source]¶

destroy_environment(env_key)[source]¶

get_pod_env(pod)[source]¶

activate_env_commands(env_key)[source]¶

deactivate_env_commands(env_key)[source]¶

_abc_impl = <_abc_data object>¶

class src.environment_manager.CondaEnvironmentManager(log=<Logger src.environment_manager (WARNING)>)[source]¶

Bases: src.environment_manager.AbstractEnvironmentManager

AbstractEnvironmentManager that uses the conda package manager to define and switch runtime environments.

env_name_prefix = '_MDTF_'¶

create_environment(env_name)[source]¶

_call_conda_create(env_name)[source]¶

create_all_environments()[source]¶

destroy_environment(env_name)[source]¶

get_pod_env(pod)[source]¶

activate_env_commands(env_name)[source]¶: Source conda_init.sh to set things that aren’t set b/c we aren’t in an interactive shell.

deactivate_env_commands(env_name)[source]¶

_abc_impl = <_abc_data object>¶

class src.environment_manager.AbstractRuntimeManager[source]¶

Bases: abc.ABC

Interface for RuntimeManagers.

abstract setup()[source]¶

abstract run()[source]¶

abstract tear_down()[source]¶

_abc_impl = <_abc_data object>¶

class src.environment_manager.SubprocessRuntimePODWrapper(pod: Any = sentinel.Mandatory, env: Any = None, env_vars: dict = <factory>)[source]¶

Bases: object

Wrapper for diagnostic.Diagnostic that adds fields and methods used by SubprocessRuntimeManager.

pod: Any = sentinel.Mandatory¶

env: Any = None¶

env_vars: dict¶

process: Any = None¶

pre_run_setup()[source]¶

setup_env_vars()[source]¶

setup_exception_handler(exc)[source]¶

run_commands()[source]¶: Produces the shell command(s) to run the POD.

run_msg()[source]¶: Log message when execution starts.

validate_commands()[source]¶

Produces the shell command(s) to validate the POD’s runtime environment (ie, check for all requested third-party module dependencies.) Dependencies are passed as arguments to the shell script src/validate_environment.sh, which is invoked in the POD’s subprocess before the POD is run.

Returns