obr.cli_util

Module Contents

Functions

query_impl(project, input_queries, filters, quiet, ...)
check_cli_operations(→ bool)	list available operations if none are specified or given the click option or an incorrect op is given
is_valid_workspace(→ bool)	This function checks if:
cli_cmd_setup(...)	This function performs the common pattern of checking project folders for existence and creating the project and extracting the jobs.
copy_to_archive(→ None)	Copies files to archive repo

Attributes

logger

obr.cli_util.logger

obr.cli_util.query_impl(project: obr.signac_wrapper.operations.OpenFOAMProject, input_queries: tuple[str], filters: list[str], quiet: bool, json_file: str, validation_file: str)

obr.cli_util.check_cli_operations(project: obr.signac_wrapper.operations.OpenFOAMProject, operations: list[str], list_operations: Any | None) → bool

list available operations if none are specified or given the click option or an incorrect op is given

obr.cli_util.is_valid_workspace(filters: list = []) → bool

This function checks if: - the workspace folder is not empty, and - applying filters would return an empty list

obr.cli_util.cli_cmd_setup(kwargs: dict) → tuple[obr.signac_wrapper.operations.OpenFOAMProject, list[signac.job.Job]]

This function performs the common pattern of checking project folders for existence and creating the project and extracting the jobs.

obr.cli_util.copy_to_archive(repo: git.repo.Repo | None, use_git_repo: bool, src_file: pathlib.Path, target_file: pathlib.Path) → None

Copies files to archive repo