Skip to main content
Ctrl+K
Zoomy Documentation - Home

User Guide

  • User Guide
    • Using the GUI
    • Using the CLI
  • Installation

Tutorials

  • SWE Tutorials
    • Shallow Water Tutorial 1D with Numpy (Simple)
    • Shallow Water Tutorial 2d with JAX (Simple)
    • Pyodide Notebook Prototype
  • SME Tutorials
    • Shallow Moment Tutorial (Simple)
    • Shallow Moment Tutorial (Minimal)
    • Time dependent boundary condition
    • Time dependent boundary condition
    • Shallow Moments with topography (Simple)
    • Shallow Moments with topography and turbulence (Advanced)
    • Time dependent boundary condition
  • AMReX Tutorials
    • Simulate from FEM
    • Raising buoy

Developer Guide

  • Developer Guide
    • Architecture Overview
    • Project Components
    • GUI and CLI Architecture
  • Testing Guide
  • Logging
  • CI Test Reports

API

  • zoomy_core package
    • zoomy_core.analysis package
      • zoomy_core.analysis.hyperbolicity module
      • zoomy_core.analysis.linearisation module
      • zoomy_core.analysis.pencil module
      • zoomy_core.analysis.plane_wave module
      • zoomy_core.analysis.plotting module
      • zoomy_core.analysis.reduce_pencil module
      • zoomy_core.analysis.system_model_analysis module
    • zoomy_core.decorators package
      • zoomy_core.decorators.decorators module
    • zoomy_core.derivation package
      • zoomy_core.derivation.ansatz module
      • zoomy_core.derivation.basis module
      • zoomy_core.derivation.closures module
      • zoomy_core.derivation.coords module
      • zoomy_core.derivation.eliminate_constraints module
      • zoomy_core.derivation.flow module
      • zoomy_core.derivation.physical_z module
      • zoomy_core.derivation.projection module
    • zoomy_core.fvm package
      • zoomy_core.fvm.legacy package
        • zoomy_core.fvm.legacy.flux module
        • zoomy_core.fvm.legacy.nonconservative_flux module
        • zoomy_core.fvm.legacy.projection_solver module
        • zoomy_core.fvm.legacy.solver_pressurized_imex module
        • zoomy_core.fvm.legacy.symbolic_numerics module
      • zoomy_core.fvm.imex_ark module
      • zoomy_core.fvm.jvp_numpy module
      • zoomy_core.fvm.ode module
      • zoomy_core.fvm.reconstruction module
      • zoomy_core.fvm.riemann_solvers module
      • zoomy_core.fvm.solver_column module
      • zoomy_core.fvm.solver_dae_numpy module
      • zoomy_core.fvm.solver_imex_numpy module
      • zoomy_core.fvm.solver_numpy module
      • zoomy_core.fvm.solver_splitting_numpy module
      • zoomy_core.fvm.timestepping module
    • zoomy_core.kernel package
      • zoomy_core.kernel.kernel module
    • zoomy_core.mesh package
      • zoomy_core.mesh.base_mesh module
      • zoomy_core.mesh.browse_meshes module
      • zoomy_core.mesh.column_structure module
      • zoomy_core.mesh.derivatives module
      • zoomy_core.mesh.fvm_mesh module
      • zoomy_core.mesh.lsq_mesh module
      • zoomy_core.mesh.lsq_reconstruction module
      • zoomy_core.mesh.mesh_catalog module
      • zoomy_core.mesh.mesh_extrude module
      • zoomy_core.mesh.mesh_util module
      • zoomy_core.mesh.subvolume_mesh module
    • zoomy_core.misc package
      • zoomy_core.misc.custom_types module
      • zoomy_core.misc.description module
      • zoomy_core.misc.interpolation module
      • zoomy_core.misc.io module
      • zoomy_core.misc.logger_config module
      • zoomy_core.misc.misc module
      • zoomy_core.misc.save_session module
    • zoomy_core.model package
      • zoomy_core.model.legacy package
        • zoomy_core.model.legacy.numerical_model module
      • zoomy_core.model.models package
        • zoomy_core.model.models.derived_chain package
        • zoomy_core.model.models.legacy package
        • zoomy_core.model.models.advection_model module
        • zoomy_core.model.models.basis_integral_cache module
        • zoomy_core.model.models.basisfunctions module
        • zoomy_core.model.models.derived_model module
        • zoomy_core.model.models.derived_system module
        • zoomy_core.model.models.divergence_theorem module
        • zoomy_core.model.models.ins3d_model module
        • zoomy_core.model.models.ins_generator module
        • zoomy_core.model.models.integrate_over_domain module
        • zoomy_core.model.models.map_to_reference module
        • zoomy_core.model.models.model_derivation module
        • zoomy_core.model.models.projected_model module
        • zoomy_core.model.models.scalar_poisson_galerkin module
        • zoomy_core.model.models.sme_model module
        • zoomy_core.model.models.symbolic_integrator module
        • zoomy_core.model.models.system_model module
        • zoomy_core.model.models.tag_catalog module
        • zoomy_core.model.models.tag_extraction module
        • zoomy_core.model.models.vam_derivation module
        • zoomy_core.model.models.vam_galerkin module
        • zoomy_core.model.models.vam_model module
        • zoomy_core.model.models.vam_projected_model module
        • zoomy_core.model.models.vam_zeta_projection module
        • zoomy_core.model.models.zeta_projection module
      • zoomy_core.model.analysis module
      • zoomy_core.model.analysis_linear module
      • zoomy_core.model.aux_boundary_conditions module
      • zoomy_core.model.basefunction module
      • zoomy_core.model.basemodel module
      • zoomy_core.model.boundary_conditions module
      • zoomy_core.model.derivative_workflow module
      • zoomy_core.model.initial_conditions module
      • zoomy_core.model.kernel_functions module
      • zoomy_core.model.splitter module
    • zoomy_core.postprocessing package
      • zoomy_core.postprocessing.plotting module
      • zoomy_core.postprocessing.postprocessing module
    • zoomy_core.preprocessing package
      • zoomy_core.preprocessing.openfoam_moments module
    • zoomy_core.symbolic package
      • zoomy_core.symbolic.auto_eval_guard module
      • zoomy_core.symbolic.canonicalise module
      • zoomy_core.symbolic.domains module
      • zoomy_core.symbolic.errors module
      • zoomy_core.symbolic.primitives_basis module
      • zoomy_core.symbolic.primitives_calculus module
      • zoomy_core.symbolic.primitives_canonical module
      • zoomy_core.symbolic.primitives_change_of_variable module
      • zoomy_core.symbolic.primitives_substitution module
      • zoomy_core.symbolic.sp_safe module
    • zoomy_core.transformation package
      • zoomy_core.transformation.generic_c module
      • zoomy_core.transformation.helpers module
      • zoomy_core.transformation.to_amrex module
      • zoomy_core.transformation.to_c module
      • zoomy_core.transformation.to_js module
      • zoomy_core.transformation.to_numpy module
      • zoomy_core.transformation.to_openfoam module
      • zoomy_core.transformation.to_ufl module
  • zoomy_jax package
    • zoomy_jax.fvm package
      • zoomy_jax.fvm.flux module
      • zoomy_jax.fvm.halo_exchange module
      • zoomy_jax.fvm.jvp_jax module
      • zoomy_jax.fvm.nonconservative_flux module
      • zoomy_jax.fvm.ode module
      • zoomy_jax.fvm.precice_solver module
      • zoomy_jax.fvm.reconstruction_jax module
      • zoomy_jax.fvm.solver_imex_jax module
      • zoomy_jax.fvm.solver_jax module
    • zoomy_jax.mesh package
      • zoomy_jax.mesh.mesh module
      • zoomy_jax.mesh.partition module
    • zoomy_jax.misc package
      • zoomy_jax.misc.io module
    • zoomy_jax.transformation package
      • zoomy_jax.transformation.to_jax module
  • API: AMReX
  • API: DMPlex
  • API: Firedrake

Legal

  • Legal Notice and Data Protection

Archive (under review)

  • Software
  • Documentation
  • Research
  • Publications explained

Legal Notice and Data Protection

Contents

  • Responsible for the content
  • Disclaimer
    • 1. Content of the online offer
    • 2. References and links
    • 3. Copyright and trademark law
    • 4. Legal validity of this disclaimer
  • Privacy Policy
    • Data protection at a glance
    • Controller
    • Contact by e-mail

Legal Notice and Data Protection#

Responsible for the content#

Ingo Steldermann
Ringstr. 103
52078 Aachen
E-Mail: info@shallowflow.com

Disclaimer#

1. Content of the online offer#

The author does not assume any liability for topicality, correctness, completeness or quality of the provided information, unless there is evidence of intentional or gross negligence.

2. References and links#

For direct or indirect references to external websites outside the author’s responsibility, liability only applies if illegal content was known and technically preventable.

3. Copyright and trademark law#

The author endeavors to observe copyrights and trademark rights for all content used or referenced.

4. Legal validity of this disclaimer#

If parts of this text become legally invalid, the remaining parts remain unaffected.

Privacy Policy#

Data protection at a glance#

We collect no data. GitHub, as a hosting service, might collect data.

Controller#

Ingo Steldermann
Schinkelstr. 2a
52068 Aachen
E-Mail: steldermann@mbd.rwth-aachen.de

Contact by e-mail#

If you contact us by e-mail, your request and related personal data are processed to handle your request. Legal retention obligations remain unaffected.

Source (adapted): https://www.e-recht24.de

previous

API: Firedrake

next

Software

Contents
  • Responsible for the content
  • Disclaimer
    • 1. Content of the online offer
    • 2. References and links
    • 3. Copyright and trademark law
    • 4. Legal validity of this disclaimer
  • Privacy Policy
    • Data protection at a glance
    • Controller
    • Contact by e-mail

By ZoomyLab

© Copyright 2026, ZoomyLab.

About · Legal notice and data protection