Welcome to xinvert’s documentation!

This is a Python package to invert or solve many classical problems in atmospheric sciences and physical oceanography. This geophysical fluid dynamics (GFD) problems are formulated as second-order partial differential equations (PDEs), and can be inverted using success-over relaxation (SOR) iteration with proper boundary conditions. This project is published on GitHub and can be cited using its Zenodo DOI.

Contents:

• Installation
  • Requirements
  • Installation from conda forge
  • Installation from pip
  • Installation from github
  • How to run the notebooks
• Introduction
  • 1. Introduction
  • 2. Mathematical background
  • 3. Physical problems at hands
• Examples
  • Poisson equation (horizontal case)
  • Poisson equation (vertical cases)
  • Balanced mass and flow
  • Eliassen vortex model
  • Reference state for shallow-water model
  • Gill-Matsuno model
  • Stommel-Munk model
  • Fofonoff flow
  • Bretherton steady flow over topography
  • QG Omega equation
• Contributors
• xinvert APIs
  • xinvert package

Indices and tables

• Index

• Module Index

• Search Page