TIDE Documentation

• Getting Started

  ---

  Install TIDE and run your first forward simulation in five minutes.

  Getting Started

• API Orientation

  ---

  Understand the difference between functional and module APIs and choose the right style.

  API Orientation

• Forward & Inversion

  ---

  Common modeling workflows and inversion loop examples.

  Modeling · Inversion

• Configuration Reference

  ---

  Full reference for storage, callbacks, backend mode, and CFL settings.

  Configuration

---

Recommended Reading Order

1. Getting Started — installation and first forward run
2. API Orientation — functional vs module API choice
3. Modeling and Inversion Workflow — common workflows
4. Configuration Reference — tuning storage, callbacks, backend mode, or CFL settings
5. Limitations and Verification — read before relying on advanced combinations

Version Requirements

TIDE requires Python ≥ 3.12 and PyTorch ≥ 2.9.1. For GPU support, install a CUDA-enabled PyTorch build first.