Skip to navigation

Development

View as Markdown

This chapter targets developers who want to contribute to the project’s core.

_core runners installers systems base_modules core_implementations registry SlurmRunner StandaloneRunner SlurmInstaller StandaloneInstaller SlurmSystem StandaloneSystem

Core Modules

We use import-linter to ensure no core modules import higher level modules.

Registry object is a singleton that holds implementation mappings. Users can register their own implementations to the registry or replace the default implementations.

Cache

Some prerequisites can be installed. For example:

Docker images, git repos with executable scripts, etc. All such “installables” are kept under the system’s install_path.

Installables are shared among all tests. Therefore, if any number of tests use the same installable, it is installed only once for a particular system TOML.

<<abstract>> Installable + __eq__(other: object) + __hash__() DockerImage + str: url: + str | Path: install_path: GitRepo + str: git_url: + str: commit_hash: + Path: install_path: PythonExecutable + GitRepo: git_repo: + Path: venv_path: <<abstract>> BaseInstaller + install(items: Iterable[Installable]) + uninstall(items: Iterable[Installable]) + is_installed(items: Iterable[Installable]): -> bool * install_one(item: Installable) * uninstall_one(item: Installable) * is_installed_one(item: Installable): -> bool SlurmInstaller StandaloneInstaller