Skip to content

v0.3.4

Choose a tag to compare

@sschwindt sschwindt released this 22 Aug 09:09
· 217 commits to main since this release

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

The docs now read in the order the tool is used

The QGIS plugin, which is the intended interface, sat eighth in the page order - behind pages a plugin user never opens - and the section names were generic where the workflow has real names.

Installation → QGIS plugin → Common Preprocessing → TELEMAC workflow → OpenFOAM workflow → Calibration → Result Visualization & Export → Advanced → Help → Development → License.

  • The index opens with About, walking the whole chain as six steps: preprocessing, initial and boundary conditions, simulation options, mesh convergence, Bayesian calibration, postprocessing visualization - each linking to the page that covers it.
  • Installation is organised around the three things installed in order: the simulation software (TELEMAC and its pysource bridge, the optional OpenFOAM Foundation build, HydroBayesCal, QGIS 3.44+), the axqua-env environment and its extras, and the plugin - whose install steps moved here.
  • The QGIS plugin page states up front that it is the primary way to use aXqua, and that the command line is an equal path rather than a fallback.
  • Result Visualization & Export gains the two sections that name needs: looking at a result (styled QGIS layers, ParaView with the wet-depth filter, the CSV and PNG tables) and exporting one (layer and raster export, the A3 print layout, the WebM movie, archiving the case folder).
  • Advanced opens with what it is for - decoupling a run from the session that started it - and that it can be skipped.
  • Development merges the former architecture and code-reference pages into one section directly above the license.

Renames are git mv, so file history is preserved, and every cross-reference is repointed.

What's Changed

  • Lead with the QGIS plugin and name the sections after the work (0.3.4) by @sschwindt in #2

Full Changelog: v0.3.3...v0.3.4