Skip to main content
Ctrl+K
PYSTILT is in alpha: names and options may change between releases.

PYSTILT 0.1.0a27

  • Getting Started
  • Tutorials
  • User Guide
  • API Reference
  • Development
  • GitHub
  • Getting Started
  • Tutorials
  • User Guide
  • API Reference
  • Development
  • GitHub

Section Navigation

  • Core Objects
    • stilt.run_trajectories
    • stilt.calc_footprint
    • stilt.Project
      • stilt.Project.config
      • stilt.Project.config_path
      • stilt.Project.name
      • stilt.Project.output
      • stilt.Project.plot
      • stilt.Project.receptors
      • stilt.Project.receptors_path
      • stilt.Project.simulations
      • stilt.Project.variants
      • stilt.Project.add_receptors
      • stilt.Project.add_table
      • stilt.Project.check
      • stilt.Project.fetch
      • stilt.Project.folders
      • stilt.Project.footprints
      • stilt.Project.incomplete
      • stilt.Project.init
      • stilt.Project.jacobian
      • stilt.Project.particles
      • stilt.Project.receptor
      • stilt.Project.run
      • stilt.Project.simulation
      • stilt.Project.status
      • stilt.Project.submit
      • stilt.Project.table_path
      • stilt.Project.transport_error
    • stilt.Receptor
      • stilt.Receptor.geometry
      • stilt.Receptor.id
      • stilt.Receptor.location_id
      • stilt.Receptor.plot
      • stilt.Receptor.points
      • stilt.Receptor.coords
      • stilt.Receptor.from_dict
      • stilt.Receptor.from_json
      • stilt.Receptor.from_points
      • stilt.Receptor.to_dict
      • stilt.Receptor.to_json
    • stilt.PointReceptor
      • stilt.PointReceptor.location_id
      • stilt.PointReceptor.coords
    • stilt.ColumnReceptor
      • stilt.ColumnReceptor.location_id
      • stilt.ColumnReceptor.coords
    • stilt.MultiPointReceptor
      • stilt.MultiPointReceptor.location_id
      • stilt.MultiPointReceptor.coords
    • stilt.read_receptors
    • stilt.receptors.write_receptors
    • stilt.receptors.receptors_to_frame
    • stilt.receptors.receptors_from_frame
    • stilt.receptors.parse_receptor_id
    • stilt.Simulation
      • stilt.Simulation.failure
      • stilt.Simulation.footprint
      • stilt.Simulation.footprint_path
      • stilt.Simulation.has_footprint
      • stilt.Simulation.has_particles
      • stilt.Simulation.id
      • stilt.Simulation.is_complete
      • stilt.Simulation.kept_workdir
      • stilt.Simulation.log
      • stilt.Simulation.log_path
      • stilt.Simulation.particles
      • stilt.Simulation.particles_path
      • stilt.Simulation.plot
      • stilt.Simulation.transport
      • stilt.Simulation.background
      • stilt.Simulation.calc_footprint
      • stilt.Simulation.transport_error
    • stilt.config.Variant
      • stilt.config.Variant.footprint_hash
      • stilt.config.Variant.footprint_settings
      • stilt.config.Variant.met_settings
      • stilt.config.Variant.particles_hash
      • stilt.config.Variant.realization_numbers
      • stilt.config.Variant.run_settings
      • stilt.config.Variant.transport_for
    • stilt.identity.run_settings
    • stilt.identity.read_run_settings
    • stilt.identity.transport_from_settings
    • stilt.identity.footprint_settings
    • stilt.identity.read_footprint_settings
    • stilt.identity.settings_hash
    • stilt.transport.ModelInfo
    • stilt.read_particles
    • stilt.particles.particles_metadata
    • stilt.particles.write_particles
    • stilt.read_footprint
    • stilt.footprint.write_footprint
    • stilt.footprint.write_empty_footprint
    • stilt.footprint.open_footprints
    • stilt.particles.ParticlesAccessor
      • stilt.particles.ParticlesAccessor.plot
      • stilt.particles.ParticlesAccessor.endpoints
      • stilt.particles.ParticlesAccessor.enhancement
    • stilt.footprint.FootprintAccessor
      • stilt.footprint.FootprintAccessor.config
      • stilt.footprint.FootprintAccessor.geometry_hash
      • stilt.footprint.FootprintAccessor.grid
      • stilt.footprint.FootprintAccessor.name
      • stilt.footprint.FootprintAccessor.plot
      • stilt.footprint.FootprintAccessor.receptor
      • stilt.footprint.FootprintAccessor.aggregate
      • stilt.footprint.FootprintAccessor.enhancement
      • stilt.footprint.FootprintAccessor.to_netcdf
    • stilt.migration.read_stilt_r
    • stilt.migration.import_stilt_r
    • stilt.particles.background
    • stilt.particles.Background
    • stilt.particles.transport_error
    • stilt.particles.TransportError
      • stilt.particles.TransportError.sd
    • stilt.Mesh
      • stilt.Mesh.bounds
      • stilt.Mesh.hash
      • stilt.Mesh.index
      • stilt.Mesh.is_longlat
      • stilt.Mesh.min_cell_width
      • stilt.Mesh.from_file
      • stilt.Mesh.from_geodataframe
      • stilt.Mesh.from_grid
      • stilt.Mesh.from_h3
      • stilt.Mesh.from_spec
      • stilt.Mesh.from_windows
      • stilt.Mesh.to_crs
      • stilt.Mesh.to_grid
    • stilt.Zones
      • stilt.Zones.crs
      • stilt.Zones.hash
      • stilt.Zones.index
      • stilt.Zones.is_longlat
      • stilt.Zones.membership
      • stilt.Zones.from_labels
      • stilt.Zones.to_grid
    • stilt.footprint.Geometry
    • stilt.footprint.overlap_weights
    • stilt.footprint.check_resolution
    • stilt.spatial.same_crs
    • stilt.spatial.is_longlat
    • stilt.spatial.horizontal_dims
    • stilt.sampling.sample_field
    • stilt.sampling.sample_met
    • stilt.sampling.vertical_dim
    • stilt.sampling.nearest_cell
  • The Particle Table
    • stilt.particles.PARTICLE_SCHEMA
    • stilt.particles.FOOTPRINT_COLUMNS
    • stilt.particles.HNF_PLUME_COLUMNS
    • stilt.particles.check_particles
    • stilt.particles.add_release_heights
    • stilt.particles.correct_near_field
  • Output Layout
  • Configuration
    • stilt.ProjectConfig
      • stilt.ProjectConfig.footprint
      • stilt.ProjectConfig.transport
      • stilt.ProjectConfig.declared
      • stilt.ProjectConfig.from_yaml
      • stilt.ProjectConfig.met_config
      • stilt.ProjectConfig.model_post_init
      • stilt.ProjectConfig.resolve
      • stilt.ProjectConfig.to_yaml
    • stilt.FootprintConfig
    • stilt.ExecutionConfig
    • stilt.Bounds
    • stilt.Grid
      • stilt.Grid.axes
      • stilt.Grid.cells
      • stilt.Grid.dims
      • stilt.Grid.index
      • stilt.Grid.is_longlat
      • stilt.Grid.to_xarray
    • stilt.footprint.config.FileGeometrySpec
    • stilt.footprint.config.H3GeometrySpec
    • stilt.footprint.config.WindowsGeometrySpec
  • Meteorology
    • stilt.transport.hysplit.MetConfig
      • stilt.transport.hysplit.MetConfig.download_options
      • stilt.transport.hysplit.MetConfig.crop
      • stilt.transport.hysplit.MetConfig.model_post_init
      • stilt.transport.hysplit.MetConfig.settings
      • stilt.transport.hysplit.MetConfig.source
    • stilt.transport.hysplit.Met
      • stilt.transport.hysplit.Met.crop_dir
      • stilt.transport.hysplit.Met.check
      • stilt.transport.hysplit.Met.check_receptors
      • stilt.transport.hysplit.Met.fetch
      • stilt.transport.hysplit.Met.files_for
      • stilt.transport.hysplit.Met.missing_hours
      • stilt.transport.hysplit.Met.readable
    • stilt.meteorology.run_window
    • stilt.meteorology.variogram
    • stilt.meteorology.fit_variogram
    • stilt.meteorology.VariogramFit
      • stilt.meteorology.VariogramFit.__call__
  • Execution
    • stilt.execution.run
    • stilt.execution.submit
    • stilt.execution.pending
    • stilt.execution.wait
    • stilt.execution.task_share
    • stilt.execution.runner.resolve_compute_root
    • stilt.execution.worker.run_particles
    • stilt.execution.worker.make_footprint
    • stilt.execution.worker.run_receptor
    • stilt.execution.worker.run_receptors
    • stilt.execution.job_script
    • stilt.transport.TransportModel
      • stilt.transport.TransportModel.config_class
      • stilt.transport.TransportModel.met_config_class
      • stilt.transport.TransportModel.data_files
      • stilt.transport.TransportModel.run
      • stilt.transport.TransportModel.version
    • stilt.transport.BatchedTransportModel
      • stilt.transport.BatchedTransportModel.run_many
    • stilt.transport.TransportConfig
      • stilt.transport.TransportConfig.UNRECORDED
      • stilt.transport.TransportConfig.realizations
      • stilt.transport.TransportConfig.settings
    • stilt.transport.ModelRun
    • stilt.transport.get_model
    • stilt.transport.run_model
    • stilt.transport.run_model_many
    • stilt.transport.hysplit.HysplitModel
      • stilt.transport.hysplit.HysplitModel.batched
      • stilt.transport.hysplit.HysplitModel.needs_workdir
      • stilt.transport.hysplit.HysplitModel.check_met
      • stilt.transport.hysplit.HysplitModel.data_files
      • stilt.transport.hysplit.HysplitModel.fetch_met
      • stilt.transport.hysplit.HysplitModel.run
      • stilt.transport.hysplit.HysplitModel.version
    • stilt.transport.stilt_r.StiltRModel
      • stilt.transport.stilt_r.StiltRModel.needs_workdir
      • stilt.transport.stilt_r.StiltRModel.data_files
      • stilt.transport.stilt_r.StiltRModel.run
      • stilt.transport.stilt_r.StiltRModel.version
    • stilt.transport.stilt_r.StiltRConfig
      • stilt.transport.stilt_r.StiltRConfig.UNRECORDED
    • stilt.transport.stilt_r.StiltRMetConfig
      • stilt.transport.stilt_r.StiltRMetConfig.settings
  • Transforms
    • stilt.transforms.AveragingKernel
      • stilt.transforms.AveragingKernel.apply
      • stilt.transforms.AveragingKernel.kernel
      • stilt.transforms.AveragingKernel.table_receptors
    • stilt.transforms.PressureWeighting
      • stilt.transforms.PressureWeighting.apply
    • stilt.transforms.FirstOrderLifetime
      • stilt.transforms.FirstOrderLifetime.apply
    • stilt.transforms.averaging_kernel_table
    • stilt.transforms.release_coordinate
    • stilt.transforms.particle_pwf
    • stilt.transforms.ak_weights
    • stilt.transforms.load_transform
    • stilt.transforms.dump_transform
    • stilt.transforms.apply_transforms
  • Observations
    • stilt.observations.receptors_from_soundings
    • stilt.observations.group_by_overpass
    • stilt.observations.select_observations_spatial
    • stilt.observations.jitter_points
    • stilt.observations.slant_points
    • stilt.observations.pressure_altitudes
    • stilt.observations.check_soundings
    • stilt.observations.read_tropomi_ch4
    • stilt.observations.read_oco2
    • stilt.observations.read_tccon
    • stilt.observations.read_ggg_oof
    • stilt.observations.read_ggg_netcdf
    • stilt.observations.plume_polygon
    • stilt.observations.Plume
    • stilt.observations.plume_background
    • stilt.observations.PlumeBackground
    • stilt.observations.plumes.kernel_density
    • stilt.observations.plumes.density_polygon
    • stilt.observations.modelled_column
  • Project And Output
    • stilt.output.Output
      • stilt.output.Output.clear_failure
      • stilt.output.Output.complete
      • stilt.output.Output.failure
      • stilt.output.Output.failures
      • stilt.output.Output.folder
      • stilt.output.Output.folders
      • stilt.output.Output.hashes
      • stilt.output.Output.keep_workdir
      • stilt.output.Output.kept_workdir
      • stilt.output.Output.log_path
      • stilt.output.Output.logged
      • stilt.output.Output.path
      • stilt.output.Output.present
      • stilt.output.Output.read
      • stilt.output.Output.record_failure
      • stilt.output.Output.table
      • stilt.output.Output.write_empty_footprint
      • stilt.output.Output.write_footprint
      • stilt.output.Output.write_log
      • stilt.output.Output.write_particles
    • stilt.output.completed
    • stilt.footprint.Jacobian
      • stilt.footprint.Jacobian.to_frame
      • stilt.footprint.Jacobian.to_xarray
  • HYSPLIT Integration
    • stilt.transport.hysplit.HysplitConfig
      • stilt.transport.hysplit.HysplitConfig.UNRECORDED
      • stilt.transport.hysplit.HysplitConfig.hourly_ziscale
      • stilt.transport.hysplit.HysplitConfig.maxpar_for
      • stilt.transport.hysplit.HysplitConfig.realizations
    • stilt.transport.hysplit.write_inputs
    • stilt.transport.hysplit.run_hycs_std
    • stilt.transport.hysplit.read_particle_dat
    • stilt.transport.hysplit.FailureReason
  • Exceptions
    • stilt.StiltError
    • stilt.exceptions.SimulationError
    • stilt.exceptions.MeteorologyError
    • stilt.exceptions.HYSPLITNotFoundError
    • stilt.exceptions.EmptyFootprint
  • API Reference
  • Core Objects
  • stilt.config.Variant
  • stilt.config.Variant.footprint_hash

stilt.config.Variant.footprint_hash#

property Variant.footprint_hash: str | None[source]#

Hash of the particles and footprint_settings, which finds the footprint folder.

previous

stilt.config.Variant

next

stilt.config.Variant.footprint_settings

On this page
  • Variant.footprint_hash
Show Source

© Copyright 2026, James Mineau.

Created using Sphinx 9.2.0.

Built with the PyData Sphinx Theme 0.23.0.