v1.0.2

Full Changelog: v1.0.1...v1.0.2

v1.0.1

Full Changelog: v1.0.0...v1.0.1

aXqua 1.0.0

The first stable release of aXqua, the QGIS plugin and the aXqua program that it drives. The plugin is no longer flagged experimental.

Install

• The plugin: axqua-qgis-1.0.0.zip below, in QGIS under Plugins > Manage and Install Plugins > Install from ZIP, until it is listed in the QGIS plugin repository.
• The aXqua program (1.0 or newer is required by the plugin): see Installation. An existing installation is updated with git pull and pip install --upgrade . in its environment.
• Documentation: axqua.eu in English, German and French.

What is new since 0.5.0

• Documentation in three languages on axqua.eu. Help opens a copy built on the computer when there is one, else the published pages, in the language of QGIS.
• Clean Up, left of Help, removes what a case no longer needs: working folders of interrupted runs, listings, earlier time steps of results, processor folders of reconstructed OpenFOAM runs and exports. Inputs, the case file, the built model and the last time step of a result are never offered, and nothing is removed while a job or a run started from a terminal may still use it (axqua cleanup in a terminal).
• One Simulations tab with Baseline (Telemac), OpenFOAM, Mesh convergence and Morphodynamics, and a mesh convergence study for OpenFOAM.
• Case settings replace the project file: the cases are kept in the QGIS settings, required entries are marked, and a table lists the measurements for calibration and validation.
• The outlet of an OpenFOAM model can follow a stage-discharge relation (the boundary condition of BAW).
• OpenFOAM runs on any number of processes, decomposed per stage; the results of an earlier run are set aside in previous-run/ instead of being deleted.
• Calibration against the targets of the case file, water depth and velocity.
• The installation wizards are tabs, run the fixes they ask for, and install again on request (replace, continue, or a new folder).
• The plugin requires the aXqua program 1.0 or newer and says so in one sentence when an older one is set.

Full changelog: v0.5.0...v1.0.0

v0.5.0

Full Changelog: v0.4.1...v0.5.0

v0.4.1

Full Changelog: v0.4.0...v0.4.1

v0.4.0

Full Changelog: v0.3.4...v0.4.0

v0.3.4

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

v0.3.3

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

• @sschwindt made their first contribution in #1

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

v0.3.2

Full Changelog: v0.3.1...v0.3.2

v0.3.1

Full Changelog: v0.3.0...v0.3.1