Skip to content

v0.3.3

Choose a tag to compare

@sschwindt sschwindt released this 19 Aug 15:35
· 231 commits to main since this release

A documentation release. No code changes beyond the version bump.

Documentation reorganised into one narrative order

The docs followed no order: usage.rst had grown to 832 lines and eighteen top-level sections, mixing the shared preparation steps with TELEMAC specifics, OpenFOAM specifics, the CLI reference and the pipeline description, beside a separate input_files.rst covering the other half of the same preparation workflow.

The page order is now the order the work happens in: Installation → Preparation → TELEMAC → OpenFOAM → Outputs → Calibration → Jobs → QGIS plugin → Architecture → Code docs → Help → License.

  • Preparation is the single common workflow: input files, drawing the layers in QGIS, the config, ground truth and its template, meshing, structures, building a case, checking its status, the command surface.
  • TELEMAC keeps only the depth-averaged path: initial condition, initial run, numerics, the 3D extension, gain-lose reaches, GAIA.
  • OpenFOAM opens by stating that TELEMAC runs first as its seed, then build and run, the seed's limits, and the rigid lid.
  • Outputs is new, and collects what was scattered across three pages: the axqua-case/ layout per phase, what the build writes, and the reports that say whether a run can be believed - flux convergence, wetted extent, outlet profile, control sections, OpenFOAM surface freedom - plus the logs and the mesh-reproducibility caveat.
  • Help is the old troubleshooting page plus a tips section, and now also holds the QGIS plugin's troubleshooting.
  • The calibration page was reachable only through a hidden toctree and is a normal entry now; the index's "Motivation" is renamed About.

usage.rst, input_files.rst and troubleshoot.rst are removed. Every :ref: label moved with its content, so nothing that links into these pages breaks.

Prose is no longer hard-wrapped

One paragraph is one line, on every page. Line breaks that carry meaning are untouched: code blocks, list-tables, simple tables, directive options, headings.

What's Changed

  • Reorganise the documentation into one narrative order (0.3.3) by @sschwindt in #1

New Contributors

Full Changelog: v0.3.2...v0.3.3