SpacePy 0.6.0 documentation¶
SpacePy is a package for Python, targeted at the space sciences, that aims to make basic data analysis, modeling and visualization easier. It builds on the capabilities of the well-known NumPy and MatPlotLib packages. Publication quality output direct from analyses is emphasized among other goals:
Quickly obtain data
Create publications quality plots
Perform complicated analysis easily
Run common empirical models
Change coordinates effortlessly
Harness the power of Python
The SpacePy project seeks to promote accurate and open research standards by providing an open environment for code development. In the space physics community there has long been a significant reliance on proprietary languages that restrict free transfer of data and reproducibility of results. By providing a comprehensive, open-source library of widely-used analysis and visualization tools in a free, modern and intuitive language, we hope that this reliance will be diminished.
When publishing research which used SpacePy, please provide appropriate credit to the SpacePy team via citation or acknowledgment.
- To cite SpacePy in publications, use (BibTeX code):
@article{niehof2022spacepy, title={The SpacePy space science package at 12 years}, author={Niehof, Jonathan T and Morley, Steven K and Welling, Daniel T and Larsen, Brian A}, journal={Frontiers in Astronomy and Space Sciences}, volume={9}, year={2022}, doi={10.3389/fspas.2022.1023612}, publisher={Frontiers} }
- To cite the code itself:
@software{spacepy_code, author = {Morley, Steven K. and Niehof, Jonathan T. and Welling, Daniel T. and Larsen, Brian A. and Brunet, Antoine and Engel, Miles A. and Gieseler, Jan and Haiducek, John and Henderson, Michael and Hendry, Aaron and Hirsch, Michael and Killick, Peter and Koller, Josef and Merrill, Asher and Rastatter, Lutz and Reimer, Ashton and Shih, Albert Y. and Stricklan, Amanda}, title = {SpacePy}, publisher = {Zenodo}, doi = {10.5281/zenodo.3252523}, url = {https://doi.org/10.5281/zenodo.3252523} }
Certain modules may provide additional citations in the __citation__
attribute. Contact a module’s author (details in the __citation__
attribute)
before publication or public presentation of analysis performed by that
module, or in case of questions about the module. This allows the author to
validate the analysis and receive appropriate credit for his or her
work.
Getting Started¶
First steps in SpacePy and scientific Python.
SpacePy Documents¶
Further reference material on how to use SpacePy, and examples.
Developer Guide¶
For those developing SpacePy, plus tips for all Python developers.
SpacePy Module Reference¶
Description of all functions within SpacePy, by module.
- spacepy - main SpacePy module
- ae9ap9 - Handle AE9/AP9 data files
- coordinates - module for coordinate transforms
- ctrans - Coordinate transformation backend
- datamanager - easy access to and manipulation of data
- datamodel - easy to use general data model
- data assimilation - data assimilation module
- empiricals - module with heliospheric empirical modules
- igrf - IGRF magnetic field model
- irbempy - Python interface to IRBEM library
- lanlstar - module to calculate Lstar or Lmax using artificial neural network
- omni - module to read and process NASA OMNIWEB data
- plot - Plot, various specialized plotting functions and associated utilities
- PoPPy - Point Processes in Python
- PyBats - SWMF & BATS-R-US Analysis Tools
- pycdf - Python interface to CDF files
- radbelt - Functions supporting radiation belt diffusion codes
- SeaPy - Superposed Epoch in Python
- time - Time conversion, manipulation and implementation of Ticktock class
- toolbox - Toolbox of various functions and generic utilities
Indices and tables¶
- Release:
0.6.0
- Doc generation date:
Apr 24, 2024