File Path Management

class vivarium_cluster_tools.psimulate.paths.InputPaths(model_specification, branch_configuration, artifact, result_directory)[source]
Parameters:
  • model_specification (None | Path) –

  • branch_configuration (None | Path) –

  • artifact (None | Path) –

  • result_directory (Path) –

model_specification: None | Path

Alias for field number 0

branch_configuration: None | Path

Alias for field number 1

artifact: None | Path

Alias for field number 2

result_directory: Path

Alias for field number 3

classmethod from_entry_point_args(*, result_directory, input_model_specification_path=None, input_branch_configuration_path=None, input_artifact_path=None)[source]
Parameters:
  • result_directory (str | Path) –

  • input_model_specification_path (str | Path) –

  • input_branch_configuration_path (str | Path) –

  • input_artifact_path (str | Path) –

Return type:

InputPaths

class vivarium_cluster_tools.psimulate.paths.OutputPaths(root, logging_root, cluster_logging_root, worker_logging_root, worker_settings, environment_file, model_specification, keyspace, branches, results)[source]
Parameters:
  • root (Path) –

  • logging_root (Path) –

  • cluster_logging_root (Path) –

  • worker_logging_root (Path) –

  • worker_settings (Path) –

  • environment_file (Path) –

  • model_specification (Path) –

  • keyspace (Path) –

  • branches (Path) –

  • results (Path) –

root: Path

Alias for field number 0

logging_root: Path

Alias for field number 1

cluster_logging_root: Path

Alias for field number 2

worker_logging_root: Path

Alias for field number 3

worker_settings: Path

Alias for field number 4

environment_file: Path

Alias for field number 5

model_specification: Path

Alias for field number 6

keyspace: Path

Alias for field number 7

branches: Path

Alias for field number 8

results: Path

Alias for field number 9

property artifact_name: str
property run_date: str
property run_type: str
property original_run_date: str
property project_name: str
property root_path: str
property logging_to_central_results_directory: bool
classmethod from_entry_point_args(*, command, input_artifact_path, result_directory, input_model_spec_path)[source]
Parameters:
  • command (str) –

  • input_artifact_path (Path | None) –

  • result_directory (Path) –

  • input_model_spec_path (Path) –

Return type:

OutputPaths

touch()[source]
Return type:

None