stilt.project.Project

class stilt.project.Project(root: 'str | Path | None' = None, *, cache_dir: 'str | Path | None' = None) → 'None'

One STILT project root plus its store.

Parameters

root

Local directory or object-store URI. A temporary directory is created when omitted.

cache_dir

Local cache for downloads from a remote store.

Methods

copy_receptors(source)	Copy an existing receptors CSV byte-for-byte into the store.
load_config()	Load config.yaml from the store.
load_receptors()	Load receptors.csv from the store, or None when absent.
save_config(config)	Write config.yaml to the store.
save_receptors(receptors)	Write receptors to receptors.csv in the store.

Attributes

directory	Local project directory.
has_config	Return whether a config has been written to the project.
has_receptors	Return whether receptors have been written to the project.
name	Human-readable project name (directory basename or URI slug).
simulations_dir	Local simulations/by-id directory.