stilt.project.Project

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

The files of one STILT project and the store that holds them.

Most code uses a project through stilt.Model, which creates one from its project argument.

Parameters

rootstr or Path, optional

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

cache_dirstr or Path, optional

Local cache for files downloaded from an object store.

Methods

add_receptors(receptors)	Add receptors to receptors.csv and return the new ones.
load_config()	Load the project's config.yaml.
load_receptors()	Load the project's receptors.csv, or return None when there is none.
load_record()	Return the settings every registered met and variant ran with.
save_config(config)	Write config to config.yaml, with only the settings that were given.
save_record(record)	Write the record of registered settings (see load_record()).

Attributes

directory	Local project directory.
has_config	Whether the project has a config.yaml.
has_receptors	Whether the project has a receptors.csv.
name	Project name, from the directory name or a slug of the URI.
simulations_dir	Local simulations/by-id directory.