SEPpy
Project description
This package is in development status! Intended for internal use only, as the syntax is in a floating state and the documentation is incomplete.
A compendium of Python data loaders and analysis tools for in-situ measurements of Solar Energetic Particles (SEP)
So far combines loaders for the following instruments into one PyPI package:
Parker Solar Probe: ISOIS
SOHO: CELIAS, COSTEP-EPHIN, ERNE
Solar Orbiter: EPD (STEP, EPT, HET)*, MAG
STEREO: HET, LET, SEPT, MAG
Wind: 3DP
(* Note that solo-epd-loader is a PyPI package itself that just is loaded here for completeness.)
Disclaimer
This software is provided “as is”, with no guarantee. It is no official data source, and not officially endorsed by the corresponding instrument teams. Please always refer to the official data description of each instrument before using the data!
Installation
seppy requires python >= 3.8.
It can be installed from PyPI using:
pip install seppy
Usage
The standard usecase is to utilize the ***_load function, which returns Pandas dataframe(s) of the corresponding measurements and a dictionary containing information on the energy channels. For example the SOHO/ERNE data from Apr 16 to Apr 20, 2021, can be obtained as follows:
from seppy.loader.soho import soho_load
df, meta = soho_load(dataset="SOHO_ERNE-HED_L2-1MIN",
startdate="2021/04/16",
enddate="2021/04/20")
Note that the syntax is different for each loader! Please refer to this Notebook for more info and examples for the different data sets!
Citation
Please cite the following paper if you use seppy in your publication:
Palmroos, C., Gieseler, J., Dresing, N., Morosan, D.E., Asvestari, E., Yli-Laurila, A., Price, D.J., Valkila, S., Vainio, R. (2022). Solar Energetic Particle Time Series Analysis with Python. Front. Astronomy Space Sci. 9. doi:10.3389/fspas.2022.1073578
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file seppy-0.1.16.tar.gz
.
File metadata
- Download URL: seppy-0.1.16.tar.gz
- Upload date:
- Size: 331.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4552419bd85d372a151d0111a833dcdab0021b89b2e65de7455bbc8960a6bd33 |
|
MD5 | 46d0e9bc7144fcba41f07688ff25c628 |
|
BLAKE2b-256 | ac2f3e3780e36c0210c7c7fdcd31900b4f2bbe597de8aa379841da83331ac82a |
File details
Details for the file seppy-0.1.16-py3-none-any.whl
.
File metadata
- Download URL: seppy-0.1.16-py3-none-any.whl
- Upload date:
- Size: 337.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 591ce14d48a18652c7dfef4d654e24c8c92c5d67751c9f9551acc2192d8a1edc |
|
MD5 | 4b32e0477cf0fbfaf8d8b82b31269440 |
|
BLAKE2b-256 | 5afd8826066e233519b4bd17c74fd67398d53af17fb0390cfea80e81b61fc686 |