Code documentation

This section addresses developers and users who call aXqua from their own Python scripts. The first page explains the structure of the software. The following pages document the modules in the order of that structure and are generated from the documentation strings in the source code.

• General structure & UML
  • Design rules
  • Packages
  • Capabilities
  • Licenses
• Configuration
  • Case description
  • Case file type
  • Classification of settings
  • Table of settings for forms
  • Check of a case
  • Profile of the computer
  • Findings of checks
  • Error types
  • Location of the simulation software
  • Environments of the simulation codes
• Solver-agnostic core
  • Geodata and rasters
  • Boundaries
  • Structures
  • Terrain from CAD surfaces
  • SELAFIN file format
  • Example cases
  • Capabilities and backend registry
• TELEMAC backend
  • Build sequence
  • Mesh and mesh quality
  • Boundary conditions
  • Steering and friction files
  • Evaluation of runs
  • TELEMAC-3D
  • Varying discharge
  • Exchange with a porous body
  • Backend adapter
• OpenFOAM backend
  • Mesh
  • Initial state from a TELEMAC result
  • Dictionaries and case assembly
  • Runs and evaluation
  • Calibration
  • Single-phase free surface
  • Fine sediment over a fixed bed
  • Backend adapter
• Workflow, studies and calibration
  • Terrain
  • Discharge data and rating curves
  • Field measurements
  • Shared steps of the case scripts
  • Mesh convergence study
  • Study of the vertical layers
  • Calibration
  • Validation
  • Progress display and logging
• Job system
  • Job description and storage
  • Processes and state reconciliation
  • Solver profiles
  • Progress events and logs
  • Submission and execution
  • Detached launchers
• Installation of the simulation software
  • Operating system
  • Installation plans
  • Example cases of TELEMAC
  • Running an installation
• Postprocessing
  • Result description
  • Figures
  • VisIt
  • Export of TELEMAC results
• Command line
  • Case commands
  • Job commands
  • Profile commands
  • Installation commands
  • Export commands
  • Case file commands
  • Example case commands
• QGIS plugin
• Building the documentation
  • Languages and publication
  • Rules for the structure