Data

Tools

Indexes

Applications

Experiments

Open Source Science

serpentine

Python tools and software developed by the SERPENTINE project for data downloading and performing of analysis and visualisation

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

Science Score: 67.0%

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

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

Repository

Python tools and software developed by the SERPENTINE project for data downloading and performing of analysis and visualisation

Basic Info
Statistics
  • Stars: 19
  • Watchers: 2
  • Forks: 4
  • Open Issues: 8
  • Releases: 5
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Code of conduct Citation Zenodo

README.md

DOI Python versions Project Status: Active – The project has reached a stable, usable state and is being actively developed. website

SERPENTINE

This repository contains the Python tools and software developed by the solar energetic particle analysis platform for the inner heliosphere (SERPENTINE) project for the downloading of data and the performing of analysis and visualisation.

Contents

Jupyter Notebooks: - Multi-Spacecraft Constellation Plotter Solar-MACH - Solar Energetic Particle Analysis Tools

Installation

  1. Make sure you have a recent version of conda installed (we recommend miniforge). To test this, open your terminal/command line/conda prompt and try to run the command conda.
  2. Download this file and extract to a folder of your choice (or clone the repository https://github.com/serpentine-h2020/serpentine if you know how to use git).

  3. Open your terminal/command line/conda prompt, navigate to the downloaded/extracted folder (which contains the file requirements.txt), and run the following:

    bash $ conda create --name serpentine python=3.12 $ conda activate serpentine $ pip install -r requirements.txt

Usage

  1. Open your terminal/command line/conda prompt.
  2. In the terminal, navigate to the downloaded/extracted folder.
  3. Make sure the corresponding conda environment is activated by running conda activate serpentine in the terminal.
  4. Run jupyter-lab, your standard web-browser should now open the JupyterLab interface.
  5. In the File Browser (click View -> File Browser if it's not shown) double-click on the notebooks folder, then sep_analysis_tools or solarmach, and finally the corresponding .ipynb file for a specific tool.

Other SERPENTINE Software

Citation

Gieseler, J., Dresing, N., Palmroos, C., von Forstner, J. L. F., Price, D. J., Vainio, R., Kouloumvakos A., Rodríguez-García L., Trotta D., Génot V., Masson A., Roth M., Veronig A. (2023). Solar-MACH: An open-source tool to analyze solar magnetic connection configurations. Front. Astronomy Space Sci. 9. doi:10.3389/fspas.2022.1058810 - If you use the Solar Energetic Particle Analysis Tools in your publication, please cite the following paper:

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

Acknowledgements

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 101004159.

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)

Citation (CITATION.cff) 

# YAML 1.2
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
cff-version: 1.0.3
message: If you use this software, please cite it using these metadata.
title: SERPENTINE
doi: 10.5281/zenodo.15827581
authors:
- given-names: Jan
  family-names: Gieseler
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0003-1848-7067
- given-names: Christian
  family-names: Palmroos
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0002-7778-5454
- given-names: Nina
  family-names: Dresing
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0003-3903-4649
- given-names: Diana
  family-names: Morosan
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0002-8416-1375
- given-names: Eleanna
  family-names: Asvestari
  affiliation: University of Helsinki
  orcid: https://orcid.org/0000-0002-6998-7224
- given-names: Aleksi
  family-names: Yli-Laurila
  affiliation: University of Turku
- given-names: Daniel
  family-names: Price
  name-particle: J.
  affiliation: University of Helsinki
  orcid: https://orcid.org/0000-0002-8065-2847
- given-names: Rami
  family-names: Vainio
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0002-3298-2067
version: 1.2.0
date-released: 2025-07-07
repository-code: https://github.com/serpentine-h2020/serpentine
license: BSD-3-Clause
preferred-citation:
  type: article
  authors:
  - given-names: Christian
    family-names: Palmroos
    orcid: https://orcid.org/0000-0002-7778-5454
  - given-names: Jan
    family-names: Gieseler
    orcid: https://orcid.org/0000-0003-1848-7067
  - given-names: Nina
    family-names: Dresing
    orcid: https://orcid.org/0000-0003-3903-4649
  - given-names: Diana
    family-names: Morosan
    orcid: https://orcid.org/0000-0002-8416-1375
  - given-names: Eleanna
    family-names: Asvestari
    affiliation: University of Helsinki
    orcid: https://orcid.org/0000-0002-6998-7224
  - given-names: Aleksi
    family-names: Yli-Laurila
    affiliation: University of Turku
  - given-names: "Daniel J."
    family-names: Price
    orcid: https://orcid.org/0000-0003-2672-5491
  - given-names: Saku
    family-names: Valkila
    affiliation: University of Turku
  - given-names: Rami
    family-names: Vainio
    orcid: https://orcid.org/0000-0002-3298-2067
  doi: 10.3389/fspas.2022.1073578
  url: http://dx.doi.org/10.3389/fspas.2022.1073578
  journal: Frontiers in Astronomy and Space Sciences
  month: 12
  title: 'Solar Energetic Particle Time Series Analysis with Python'
  volume: 9
  year: 2022

GitHub Events

Total
  • Issues event: 3
  • Watch event: 1
  • Issue comment event: 7
  • Push event: 11
  • Pull request event: 14
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 3
  • Watch event: 1
  • Issue comment event: 7
  • Push event: 11
  • Pull request event: 14
  • Fork event: 2
  • Create event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 14
  • Average time to close issues: over 1 year
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 1
  • Pull requests: 9
  • Average time to close issues: 11 months
  • Average time to close pull requests: about 1 hour
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.78
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • jgieseler (4)
Pull Request Authors
  • jgieseler (13)
  • pre-commit-ci[bot] (1)
Top Labels
Issue Labels
enhancement (2)
Pull Request Labels

Dependencies

notebooks/sep_analysis_tools/requirements.txt pypi
  • astropy >=4.3.1
  • astroquery *
  • ipympl *
  • ipywidgets *
  • jupyter *
  • matplotlib >=3.4.3
  • matplotlib-inline ==0.1.3
  • numpy >=1.20.3
  • pandas >=1.3.4
  • seppy >=0.1.0
  • solo_epd_loader >=0.1.10
  • sunpy >=4.0
notebooks/solarmach/requirements.txt pypi
  • cmasher >=1.6.3
  • drms >=0.6.2
  • jupyter *
  • pfsspy *
  • solarmach *
  • zeep >=4.1.0