Transient Grating Project documentation

This documentation combines:

• Automatic API reference generated from docstrings in src/tg_analysis.py.

• Manual usage guides reproducing the workflow in src/results_tg.ipynb.

• Model notes aligned with the current fit parameterization used in the code.

Contents

• Quickstart
  • Prerequisites
  • Minimal example
  • Common next steps
• Installation and docs build
• Usage guide (based on results_tg.ipynb)
  • Minimal workflow
  • Batch export (notebook)
  • What each block does in practice
  • Recommended good practices
• Fit models
  • Notation
  • Model 1 (model1)
  • Model 2 (model2)
  • Model 3 (model3)
  • Bounds and reported \(\tau\)
  • Practical note
• API reference
  • Main module