PyGS

Magnetic flux rope detection and reconstruction based on the extended Grad-Shafranov equation for in-situ spacecraft measurements.

This package consists of two key products to serve as a set of comprehensive tools for the investigation of magnetic flux ropes (FRs) in space plasmas based on in-situ spacecraft measurements. The Grad-Shafranov (GS)-based detection (GSD) automatedly identifies flux ropes and outputs their parameters to support statistical analysis, relying on the generalized version of the GS equation. It is applicable to FRs with a broad definition including both static and dynamic structures, and works with PSP, Solar Orbiter, Ulysses, ACE, and WIND spacecraft datasets. The Grad-Shafranov (GS) type reconstruction (GSR) visualizes and characterizes the 2D magnetic field configuration from 1D time-series data, confirms the flux rope detection results, and derives flux rope parameters such as the poloidal and toroidal magnetic fluxes, the relative helicity, and average twist.