API Reference

Complete API documentation for all modules, classes, and functions in SolarWindPy.

Top-Level API

Core classes and functions available at the package level.

Plasma(data, *species[, spacecraft, ...])	Container for multi-species plasma physics data and analysis.
Hist1D(x[, y, logx, axnorm, clip_data, ...])	Create 1D plot of x, optionally aggregating y in bins of x.
Hist2D(x, y[, z, axnorm, logx, logy, ...])	Create a 2D histogram with an optional z-value using an equal number.
TeXlabel(mcs0[, mcs1, axnorm, ...])	Create a LaTeX label from measurement, component and species information.

Core Module

Main data structures, physics calculations, and fundamental classes for solar wind analysis. The core module provides the Plasma container class and Ion species class, along with vector/tensor operations and physical constants.

solarwindpy.core.plasma	The Plasma class that contains all Ions, magnetic field, and spacecraft information.
solarwindpy.core.ions	Contains Ion class.
solarwindpy.core.base	Contains in situ data Base and Core classes.
solarwindpy.core.vector	A Vector class and subclasses.
solarwindpy.core.tensor	Tensor class for storing quantities like thermal speed, pressure, and temperature.
solarwindpy.core.spacecraft	Contais Spacecraft class.
solarwindpy.core.alfvenic_turbulence	Alfvenic turbulence diagnostics using Elsasser variables.
solarwindpy.core.units_constants	Definitions of common units and physical constants.

Plotting Module

Visualization tools for creating publication-quality scientific figures. Includes histogram classes with aggregation, scatter plots, scientific labels with automatic units, and helper functions for figure management.

solarwindpy.plotting.histograms	Convenience accessors for histogram style plotters.
solarwindpy.plotting.labels	Tools for creating physical quantity plot labels.
solarwindpy.plotting.scatter	Scatter plot utilities with optional color mapping.
solarwindpy.plotting.spiral	Spiral mesh plots and associated binning utilities.
solarwindpy.plotting.orbits	Plotting helpers specialized for solar wind orbits.
solarwindpy.plotting.tools	Utility functions for common matplotlib tasks.
solarwindpy.plotting.select_data_from_figure	Interactive selection utilities for plotted data.

Fit Functions Module

Statistical analysis and curve fitting tools for solar wind data. Provides parametric fit functions (Gaussian, exponential, power law, Moyal) with automatic parameter estimation, plotting utilities, and trend analysis.

solarwindpy.fitfunctions.core	Base classes used to implement specific fit functions.
solarwindpy.fitfunctions.gaussians	Gaussian-based fit functions.
solarwindpy.fitfunctions.exponentials	Fit functions for exponential models.
solarwindpy.fitfunctions.power_laws	Utilities for fitting power-law models.
solarwindpy.fitfunctions.moyal	Moyal distribution fit function for asymmetric peak fitting.
solarwindpy.fitfunctions.lines	Simple linear fit functions.
solarwindpy.fitfunctions.trend_fits	trend_fits.
solarwindpy.fitfunctions.plots	Plotting utilities for solarwindpy.fitfunctions.
solarwindpy.fitfunctions.tex_info

Solar Activity Module

Tools for accessing and analyzing solar activity indices. Includes sunspot number data, LISIRD (LASP Interactive Solar Irradiance Data Center) access, and solar cycle analysis.

solarwindpy.solar_activity.base	Base classes for solar activity indicators.
solarwindpy.solar_activity.plots	Plotting helpers for solar activity indicators.
solarwindpy.solar_activity.sunspot_number	Sunspot number data utilities.
solarwindpy.solar_activity.lisird

Instabilities Module

Plasma instability analysis and threshold calculations. Includes temperature anisotropy instability thresholds based on Verscharen et al. (2016) and related analyses.

solarwindpy.instabilities.verscharen2016	Instability thresholds from Verscharen et al. (2016).
solarwindpy.instabilities.beta_ani	Convenience plotting helpers for anisotropy versus beta.

Tools Module

General utility functions and helper tools for data manipulation and analysis.

solarwindpy.tools

Utility functions for manipulating solar wind data.