Welcome to the OCBpy documentation

This documentation describes the Open Closed field line Boundary (OCB) gridding process and provides examples for usage.

• Overview
• Citation Guide
  • OCBpy
  • Authors
  • Contributors
  • IMAGE FUV Boundaries
  • AMPERE Boundaries
  • DMSP SSJ Boundaries
• Boundary Data Sets
  • IMAGE
  • AMPERE
  • DMSP SSJ
  • Boundaries Module
    • Boundary Files
    • DMSP SSJ Files
• OCB Gridding
  • Boundary Classes
  • Cycle Boundary Module
  • OCB Scaling Module
• OCB Boundary Correction
  • OCB Correction Module
• Supported Instrument Data Sets
  • General Instrument Module
  • SuperMAG Instrument Module
  • SuperDARN Vorticity Instrument Module
  • pysat Instrument Module
  • Time Handling Module
• Examples
  • Getting Started
    • Initialise an OCBoundary object
    • Other Boundary classes
  • Selecting Boundaries
    • Retrieve a good OCB record
    • Retrive a good DualBoundary record
  • Coordinate Convertion
    • Convert between AACGM and OCB coordinates
    • Convert between AACGM and dual-boundary coordinates
  • DMSP SSJ Boundaries
    • Loading DMSP SSJ Boundaries
    • Using DMSP SSJ Boundaries
  • Load a general data file (DMSP SSIES)
  • Grid and scale vector data
    • Single Boundary Transformation
    • Dual Boundary Transformation
  • Using data from pysat (with EAB)
    • Using Equatorward Auroral Boundaries
    • Load a pysat Instrument (Madrigal TEC)
• Contributing
  • Short version
  • Bug reports
  • Feature requests and feedback
  • Development
    • Pull Request Guidelines
    • Tips
  • Contributor Covenant Code of Conduct
    • Our Pledge
    • Our Standards
    • Our Responsibilities
    • Scope
    • Enforcement
    • Attribution
  • Changelog
    • 0.3.0 (10-21-2022)
    • 0.2.1 (11-24-2020)
    • 0.2.0 (10-08-2020)

Indices and tables

• Index
• Module Index
• Search Page