PlanetMag documentation

This is the documentation for the code base of the PlanetMag framework. The software is hosted on GitHub at https://github.com/coreyjcochrane/planetmag and mirrored at https://github.com/NASA-Planetary-Science/PlanetMag.

Please refer to the README for the overall package description, installation instructions, and copyright information.

Contents:

• README
  • Installation
  • Running the software
  • Acknowledging PlanetMag
  • Open-source license
  • Copyright notice
  • Disclaimer
• PlanetMag Matlab run scripts
  • PlanetMag()
  • CompareEarModels()
  • CompareJupModels()
  • CompareSatModels()
  • CompareUraModels()
  • CompareNepModels()
  • Spherical harmonics validation
  • Basic testing
• Matlab supporting functions
  • Main calculation functions
  • Coordinate transformation functions
  • Khurana and Schwarzl (2005) Jupiter model functions
  • Additional supporting functions
  • Model coefficient functions
  • Magnetopause functions
  • Figure plotting functions
• PlanetMag Python documentation
  • workspace
• Implemented frames and coordinates
  • IAU frames
  • System III frames
  • SPRH frames
  • Planet–Sun–Orbit frames
  • Planet–Sun–Magnetic frames
  • Planet–Dipole–Solar–Zenith frames
  • Solar–Magnetic–Planet frames
• PlanetMag manuscript data and figure scripts
  • CalcBexc()
  • CompareCoords()
  • GetNearFarMaxBdiff()
  • MakeHodograms()
  • PrintSurfaceMap()
  • RunPublication()
  • makeSurfaceMaps
  • hodogram
  • plotFFT

Package index

• Index