Data

Tools

Indexes

Applications

Experiments

Open Source Science

seppy

A compendium of Python data loaders and analysis tools for in-situ measurements of Solar Energetic Particles (SEP)

https://github.com/serpentine-h2020/seppy

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

A compendium of Python data loaders and analysis tools for in-situ measurements of Solar Energetic Particles (SEP)

Basic Info
  • Host: GitHub
  • Owner: serpentine-h2020
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 1.16 MB
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 6
  • Open Issues: 13
  • Releases: 23
Created about 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Zenodo

README.rst 

seppy
=====

|pypi Version| |python version| |pytest| |codecov| |docs| |repostatus| |zenodo doi|

.. |pypi Version| image:: https://img.shields.io/pypi/v/seppy?style=flat&logo=pypi
   :target: https://pypi.org/project/seppy/
.. |python version| image:: https://img.shields.io/pypi/pyversions/seppy?style=flat&logo=python
.. |zenodo doi| image:: https://zenodo.org/badge/451799504.svg
   :target: https://zenodo.org/badge/latestdoi/451799504
.. |pytest| image:: https://github.com/serpentine-h2020/SEPpy/actions/workflows/pytest.yml/badge.svg?branch=main
.. |codecov| image:: https://codecov.io/gh/serpentine-h2020/SEPpy/branch/main/graph/badge.svg?token=FYELM4Y7DF 
   :target: https://codecov.io/gh/serpentine-h2020/SEPpy
.. |docs| image:: https://readthedocs.org/projects/seppy/badge/?version=latest
   :target: https://seppy.readthedocs.io/en/latest/?badge=latest
.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg
   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
   :target: https://www.repostatus.org/#active

*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:

- BepiColombo: SIXS-P
- 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.9.

It can be installed from `PyPI `_ using:

.. code:: bash

    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:

.. code:: python

   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 `_

Owner

  • Name: serpentine-h2020
  • Login: serpentine-h2020
  • Kind: organization

A European Union funded Research and Innovation Action: Solar energetic particle analysis platform for the inner heliosphere (SERPENTINE)

GitHub Events

Total
  • Create event: 6
  • Release event: 4
  • Issues event: 3
  • Watch event: 4
  • Delete event: 1
  • Issue comment event: 19
  • Push event: 15
  • Pull request event: 37
Last Year
  • Create event: 6
  • Release event: 4
  • Issues event: 3
  • Watch event: 4
  • Delete event: 1
  • Issue comment event: 19
  • Push event: 15
  • Pull request event: 37

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 68
  • Total Committers: 3
  • Avg Commits per committer: 22.667
  • Development Distribution Score (DDS): 0.632
Top Committers
Name Email Commits
jgieseler j****r@u****i 25
Jan Gieseler 3****r@u****m 22
Christian-Palmroos c****a@u****i 21
Committer Domains (Top 20 + Academic)
utu.fi: 2

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 21
  • Total pull requests: 91
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 18 hours
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.76
  • Average comments per pull request: 0.31
  • Merged pull requests: 83
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 2
  • Pull requests: 40
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 2
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.55
  • Merged pull requests: 33
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
  • jgieseler (18)
  • Christian-Palmroos (1)
  • bheber-kiel (1)
  • tlml (1)
Pull Request Authors
  • jgieseler (78)
  • Christian-Palmroos (12)
  • dependabot[bot] (2)
  • ZigongXu (1)
Top Labels
Issue Labels
bug (6) enhancement (5) wontfix (1)
Pull Request Labels
dependencies (2) github_actions (2) bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,061 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 25
  • Total maintainers: 1
pypi.org: seppy

SEPpy

  • Versions: 25
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 1,061 Last month
Rankings
Dependent packages count: 4.8%
Forks count: 15.3%
Downloads: 15.4%
Average: 15.7%
Stargazers count: 21.5%
Dependent repos count: 21.6%
Maintainers (1)
jgieseler
Last synced: 7 months ago

Dependencies

requirements.txt pypi
  • astropy *
  • bs4 *
  • cdflib *
  • datetime *
  • drms *
  • h5netcdf *
  • lxml *
  • matplotlib *
  • numpy *
  • pandas *
  • pooch *
  • requests *
  • sunpy >=4.0.0
  • zeep *
.github/workflows/pytest.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • codecov/codecov-action v3 composite
pyproject.toml pypi
setup.py pypi