PlesioGeostroPy

PlesioGeostroPy is the Python realization of the Plesio-Geostrophy model (PG, Jackson and Maffei 2020), a type of quasi-geostrophic model for magneto-hydrodynamic system in planetary dynamos. For a more detailed description of the PG model, see e.g. Jackson and Maffei (2020) or Holdenried-Chernoff (2021).

The package PlesioGeostroPy aims to provide robust and efficient numerical solution to the PG model, which can then be plugged into data assimilation frameworks for geomagnetic data assimilation (GDA). For information regarding this project, including the formulations, downloadable resources, etc., see the the project homepage.

---

Tutorials

PlesioGeostroPy 101

These contain the most essential features of PlesioGeostroPy, especially in symbolic manipulations.

• Introducing PlesioGeostroPy: Quickstart

• Intro to the collection interface

• Variables, equations and forcing terms

• Regularity conditions for tensor components in polar coordinates

More advanced tutorials are yet to come.

---

API Reference

The core of the code is the following package:

pg_utils

PlesioGeostroPy: a Python package for the Plesio-Geostrophy (PG) model.

This packages is then subdivided into four modules: module sympy_supp for supplementary functions for symbolic manipulation; module pg_model for the actual implementation of the symbolic PG model, including variables, equations and the recipes for spectral expansions; module numerics for numerical computations; and module processing for pre- and post-processing.

Here you can find the indexed reference to all of the modules, and the classes and objects within.

• Module Index

• Index

You can also use the search function to look for all items.