Guides

Choose a task, follow its steps, and use Reference when you need an exact signature. For installation and your first successful run, use Get started.

Start from a working model

Run a model and inspect its result — continue the installed decay example, understand the output and change a parameter.
How Eqiora fits together — follow Model → realization → run → result and find the right place for each choice.

Use the environment and source checkout from Get started for these guides. Each guide introduces the extra inputs or optional dependencies it needs.

Configure Vim, Neovim, or another LSP client — use a released server for diagnostics, hover, formatting and declaration navigation.
Create and share a library — lay out an Eqiora package, import it locally, publish it on GitHub, and lock or vendor its dependencies.
Modeling and realization — author declarations and Eqiora source; bind boundaries, geometry and mesh; resolve packages; configure flow and solid runs.
Execution, diagnostics, and arrays — submit and observe a run, inspect structured failures, and handle NumPy and DLPack ownership.
Notebook source cells — compile Eqiora cells in an IPython kernel using the packaged extension.
Differentiation and framework adapters — differentiate a solved field, evaluate parameter batches, and connect PyTorch or JAX.

The Gallery keeps each physical setup, source, reproduction path and result together. Learn the underlying mathematics, look up the Language and APIs, or contribute a new example.