API reference

Generated from the package. Most things documented here are importable directly from the top level (from minisim import ...); the testing helpers live in the minisim.testing submodule.

• Spec and steps
  • Spec
  • Acquisition and physical models
  • Output
  • Steps
  • Warnings
• Presets and build_spec
  • Scope
  • Region
  • Compose with build_spec
  • Example
• Simulation
  • simulate
  • simulate_cached
  • simulate_video
  • sweep
• Recording and ground truth
  • Recording
  • GroundTruth
  • finalize
  • RecordingFormatWarning
• Scene construction
  • Scene
  • Cell
  • GroundTruthBuilder
• Recovery metrics
  • Spatial matching
  • Temporal scores
  • Field and motion
• Testing helpers
  • make_recording
  • score
  • Estimate
  • Report
• Caching
  • simulate_cached
  • cache_dir
  • cache_path
• Reproducibility & stability contract
  • The core guarantee
  • Frozen across patch releases (changing these is breaking)
  • Reading the recall denominator
  • On-disk format
  • Not frozen (free to change)

At a glance

Symbol	Role
Spec	The typed, validated recording specification (the input you build).
build_spec()	Compose a Scope × Region preset into a Spec.
simulate()	Run the forward pipeline; returns a Recording.
simulate_cached()	As simulate, memoized to disk by spec.cache_key().
simulate_video()	Simulate straight to a grayscale video, streamed to disk.
sweep()	Cartesian-product generator over spec overrides.
Recording	The result: observed movie, ground_truth, per-stage snapshots.
GroundTruth	The exact generators (footprints, traces, spikes, optical fields).
metrics	Score recovered cells, traces, spikes, and motion against truth.
make_recording() / score()	One-call CI fixture and recovery scorecard (in minisim.testing).