[general]
name=aXqua
qgisMinimumVersion=3.44
qgisMaximumVersion=4.99
description=Set up, run and monitor TELEMAC and OpenFOAM models of free-surface water bodies (rivers, lakes, reservoirs, hydraulic structures) from QGIS, with jobs that keep running after QGIS is closed.
about=aXqua turns geodata into a calibration-ready hydro- and morphodynamic model (TELEMAC-2D/3D with GAIA, or an OpenFOAM interFoam free-surface case) and drives it through a persistent job runner. Simulations are launched as detached system jobs, so they survive closing QGIS, and are rediscovered with their live state when you reopen it. Results load back as mesh, raster and vector layers, with depth and velocity styling applied to the meshes. The plugin drives the aXqua command-line tool, installed separately with 'pip install axqua', and needs a working TELEMAC and/or OpenFOAM installation.
version=1.2.1
author=Sebastian Schwindt
email=schwindt.water@gmail.com

tracker=https://github.com/sschwindt/aXqua/issues
repository=https://github.com/sschwindt/aXqua
homepage=https://axqua.eu

# The plugin itself is GPLv2+ because it links PyQGIS. The axqua package it
# drives stays BSD-3-Clause, which is GPL-compatible, and remains usable on its own.
license=GPL-2.0-or-later

category=Plugins
icon=resources/axqua.png
tags=hydraulics,hydrodynamics,telemac,openfoam,cfd,river,lake,reservoir,hydraulic structures,mesh,simulation,calibration,morphodynamics

experimental=False
deprecated=False
server=False
hasProcessingProvider=yes

changelog=1.2.1
    - Hydrology mode: the sediment budget of a run on several processor cores
      is right. TELEMAC v9.1.1 writes into each processor's listing only the
      suspended sediment that left through its own part of the mesh; aXqua now
      adds the listings of all processors. Eroded and deposited mass come from
      GAIA's erosion and deposition fluxes. aXqua 1.2.0 counted the sediment that
      left through the other parts as deposited.
    - The fix is in the aXqua program: upgrade it with
      'pip install --upgrade axqua'.
    1.2.0
    - Setup Wizard for TELEMAC and OpenFOAM on the Configuration tab: select an
      existing environment script, which aXqua checks module by module (a valid
      installation that lacks GAIA, TELEMAC-3D or sediDriftFoam2 is told apart
      from an invalid one), or install the program.
    - Hydrology mode: sediment transport with GAIA, strongly recommended, with the
      Sediment transport wizard (soil layer, grain sizes, a recommendation after
      van Rijn and Partheniades for the soil and the slope) and a sediment budget
      of the run. The checkup refuses sediment setups that TELEMAC cannot run
      where a river flows into the model.
    - Hydrology mode: optional river lines, an inflow line with the discharge of a
      river and its outflow line with an outlet of its own (data wizard, tab
      River).
    - The example example-agrohydrology transports sediment.
    - Steering files keep every line within the 72 columns TELEMAC reads.
    - Needs the aXqua program 1.2.
    1.1.1
    - Load results: the layers "infiltrated depth" and "high water mark" of a
      hydrology run showed the water depth of the first time step. Each now shows
      its own variable, and the high water mark is drawn as the highest water
      depth (the mark minus the bed). Results of aXqua 1.1.0 are read too.
    - The aXqua program is published on PyPI by the release workflow.
    1.1.0
    - Hydrology mode: rainfall-runoff over a catchment or a field with TELEMAC-2D
      and Green-Ampt infiltration, rain uniform in space, wind and evaporation.
      The sub-tab Simulations > Hydrology runs it, a data wizard fetches or reads
      rain, soil, initial moisture, wind and sun, and a checkup of the data and of
      the terrain runs before the build.
    - A second example case, example-agrohydrology: an arable field in Lower
      Bavaria under a storm of 42 mm in 7 hours.
    - The plugin passes the Qt6 check of the QGIS plugin repository.
    - The plugin needs the aXqua program 1.1 or newer. Upgrade it with
      'pip install --upgrade axqua'.
    1.0.2
    - The inflow of a model received no discharge when the south-westernmost node
      of its outline was the last node of a liquid boundary line: TELEMAC then
      numbers that line last, and the discharge went to the outflow. The numbering
      of aXqua now follows TELEMAC in this case too. Rebuild a model that was built
      with an earlier version.
    - The gauge tool (scripts/gauge_data.py) keeps the fetched gauge when a table
      is downloaded, so the hydrograph and the rating curve can be saved one after
      the other.
    1.0.1
    - The aXqua program is published on PyPI. Install it with 'pip install axqua'
      and upgrade it with 'pip install --upgrade axqua'; Git and a copy of the
      repository are no longer needed.
    1.0.0
    - The first stable release. It needs the aXqua program 1.0 or newer.
    - Documentation in English, German and French at https://axqua.eu. Help opens
      a copy built on this 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 run may still use it.
    - 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; 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.
    0.5.0
    - Installation wizards for TELEMAC, OpenFOAM with the sediment solvers, ParaView
      and VisIt, for you alone or for all users of the computer.
    - The OpenFOAM installation no longer depends on the website of the sediment
      solvers: their source code ships with aXqua.
    - A profile per computer names where the programs are installed; a case file
      (.axq-case) describes the reach. The profile editor and the case editor edit
      them, and a check reports everything that is not in order at once.
    - The panel follows the workflow: Configuration, Case Setup, Preprocessing,
      Hydraulic simulation, Morphodynamic simulation, Calibration and validation,
      Postprocessing, Batch-processing, each with its Help page.
    - Jobs of a case run one after the other and keep running when QGIS is closed.
    - Validation of a calibrated model against measurements of another flow
      situation.
    - Fine sediment over a bed that stays in place, simulated with OpenFOAM.
    - Results export to ParaView and VisIt; a loaded result shows its last time
      step.
    - The Isar example case downloads with its data and a step-by-step guide.
    - Export movie is in the aXqua menu, and QGIS stays responsive while aXqua
      works.
    - Errors show what aXqua said and what to do about it.
    0.2.0
    - First release.
    - Persistent job runner: submit, monitor and cancel TELEMAC/OpenFOAM runs that
      outlive the QGIS session.
    - Job dashboard with adaptive polling, rediscovery from a .axqua-prj project.
    - Tabs generated from axqua's capability matrix, so a case only offers what it
      can actually do.
    - Result loading with depth and velocity styling, plus an A3 print layout.
    - Processing algorithms that submit and return rather than blocking QGIS.
