Quasi-Geostrophic Spectral model (qgs)

qgs is quasi-geostrophic atmospheric model which is integrally written in Python. The lower boundary condition can be either a surface with orography or a dynamical ocean.

Contents:

• General Information
  • Statement of need
  • Installation
  • Documentation
  • Usage
  • Examples
  • Dependencies
  • Forthcoming developments
  • Contributing to qgs
  • Reporting issues with the software and getting support
  • Other atmospheric models in Python
  • References
• Model Description
  • Components description
  • Model versions description
• Code Description
  • Special case with the quartic temperature scheme
  • Computational flow
  • Additional technical information
  • References
• User guide
  • 1. Rationale behind qgs
  • 2. Configuration of qgs
  • 3. Using user-defined symbolic basis
  • 4. Using qgs (once configured)
  • 5. Developers information
  • References
• References
  • Model configuration
  • Inner Products
  • Tensors module
  • Functions module
  • Diagnostics
  • Integration modules
  • Miscellaneous modules
  • Toolbox module
• Examples
  • Recovering the result of Reinhold and Pierrehumbert (1982)
  • Recovering the result of De Cruz, Demaeyer and Vannitsem (2016)
  • Atmospheric model with heat exchange - Li et al. model version (2017)
  • Example of DiffEqPy usage
  • Example of the tangent linear and adjoint models usage
  • Recovering the result of Vannitsem, Solé-Pomies and De Cruz (2019)
  • Manual setting of the basis
  • Recovering the result of Hamilton et al. (2023)

Indices and tables

• Index

• Module Index

• Search Page

About

Part of the code comes from the Python MAOOAM implementation by Maxime Tondeur and Jonathan Demaeyer.

Please cite the code description article if you use (a part of) this software for a publication:

• Demaeyer J., De Cruz, L. and Vannitsem, S. , (2020). qgs: A flexible Python framework of reduced-order multiscale climate models. Journal of Open Source Software, 5(56), 2597, https://doi.org/10.21105/joss.02597.

Please consult the qgs code repository for updates.

qgs is licensed under the MIT license:

The MIT License (MIT)

Copyright (c) 2020-2023 qgs Developers and Contributors


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.