PySPEDAS: Difference between revisions

From SPEDAS Wiki
Jump to navigation Jump to search
 
(13 intermediate revisions by 2 users not shown)
Line 13: Line 13:
PySPEDAS is one of the core packages of the [http://pyhc.org Python Heliophysics Community].
PySPEDAS is one of the core packages of the [http://pyhc.org Python Heliophysics Community].


== Getting started with PySPEDAS ==
== New user installation and setup guides ==
For new PySPEDAS users (including those new to Python), instructions for setting up a Python environment and installing PySPEDAS can be found here: [[Getting_Started_with_pySPEDAS]]
 
For new PySPEDAS users (including those new to Python), we have a simplified guide to installing Python and PySPEDAS, geared toward users who want to get up and running quickly, with a set of tools and options that should work for most users:  [[PySPEDAS simple installation guide]]
 
For those who want more choices about what tools to use and how to set up their environment, we have a guide with a more "choose your own adventure" approach: [[Getting Started with pySPEDAS]]


== Documentation ==
== Documentation ==


== Contributing ==
== Contributing ==
We welcome contributions of new code, bug fixes, documentation, or usage examples! 
Please see our [[PySPEDAS docstring format]] for our preferred style of commenting.


== Other resources ==
== Other resources ==

Latest revision as of 19:30, 5 January 2024

About PySPEDAS

PySPEDAS is the Python implementation of SPEDAS (Space Physics Environment Data Analysis Software). It supports most of the capabilities of SPEDAS, including:

  • The ability to load heliophysics data sets from more than 30 space-based and ground-based missions
  • Interactive access to many more data sets via NASA's CDAWeb service, and the HAPI data locator and download interface
  • Support for the "tplot variable" data structure and tools, and SPEDAS-like plotting in conjunction with PyTplot, the Python implementation of the IDL tplot tools
  • Field and wave analysis tools: wavelet analysis, power spectra, wave polarization analysis
  • Magnetic field modeling: Tyganenko field models via native Python geopack package; magnetopause and neutral sheet models
  • Coordinate transforms, interpolation routines, unit conversions
  • Particle tools: plasma moments, 1-D and 2-D slices from calibrated 3-D particle distributions

PySPEDAS is one of the core packages of the Python Heliophysics Community.

New user installation and setup guides

For new PySPEDAS users (including those new to Python), we have a simplified guide to installing Python and PySPEDAS, geared toward users who want to get up and running quickly, with a set of tools and options that should work for most users: PySPEDAS simple installation guide

For those who want more choices about what tools to use and how to set up their environment, we have a guide with a more "choose your own adventure" approach: Getting Started with pySPEDAS

Documentation

Contributing

We welcome contributions of new code, bug fixes, documentation, or usage examples!

Please see our PySPEDAS docstring format for our preferred style of commenting.

Other resources