Project And Store#

A project is one folder or cloud bucket path. It holds config.yaml, receptors.csv, and simulations/by-id/. Every output’s location is given relative to the project root, and a simulation is finished when its outputs exist there (see How PYSTILT Tracks Finished Work). The store reads and writes those files, on a local disk or in a bucket. Most users never use these classes directly. stilt.Model uses them for you.

Project#

stilt.project.Project

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

stilt.project.simulation_prefix

Return the key prefix of one simulation's outputs, simulations/by-id/<receptor_id>/<variant>.

stilt.project.project_slug

Return a lowercase, hyphenated name for a project path or URI, safe for filenames and DNS.

Store backends#

stilt.store.Store

Interface for reading and writing project files by key.

stilt.store.LocalStore

Store backed by a local directory.

stilt.store.FsspecStore

Store backed by an fsspec filesystem such as s3:// or gs://.

stilt.store.make_store

Return the store for a project root.