stilt.storage.ProjectFiles

class stilt.storage.ProjectFiles(root: 'Path') → None

Local paths plus output key conventions for one project root.

Parameters

root

Project root directory that contains config, receptors, and outputs.

Methods

config_key()	Return the canonical output-store key for the project config.
footprint_index_key(filename)	Return the flat footprint-index key for one filename.
particle_index_key(filename)	Return the flat particle-index key for one filename.
receptors_key()	Return the canonical output-store key for the receptors file.
simulation(sim_id)	Return file helpers rooted at one simulation's output directory.
simulation_prefix()	Return the canonical output-store prefix for by-id simulations.

Attributes

root
by_id_dir	Return the directory that stores one subdirectory per simulation.
chunks_dir	Return the directory used for chunked intermediate artifacts.
config_path	Return the local path to the project config file.
footprint_index_dir	Return the directory used for flat footprint-file aliases.
index_db_path	Return the local path to the simulation index database.
particle_index_dir	Return the directory used for flat particle-file aliases.
receptors_path	Return the local path to the project receptors CSV file.
simulations_dir	Return the directory that stores indexed simulation outputs.