Tools

The tools developed within the SPEARHEAD project are presented here. They are shared open access via the official SPEARHEAD repository on GitHub and the SPEARHEAD Jupyterhub where available.

You can find a user guide for the SPEARHEAD Jupyterhub here.

bowtie: Bow-tie analysis for the energy channels of a generic particle instrument

This analysis tool runs a bow-tie analysis (Van Allen et al. 1974) for the energy channels of a generic particle instrument. The input is a csv table of channel responses indexed by the incident energy. The results of analysis are the geometric factor (with errors) and the effective energy of the channel.

 

FDAT: Forbush Decrease Analysis Tool

A graphical interface tool for analyzing Forbush decrease and Interplanetary Coronal Mass Ejection (ICME) events, conducting ForbMod best-fit calculations on selected data regions and performing in-situ analysis of ICMEs.

FDAT enables to:

  • Plot and analyze ICME/Forbush decrease events
  • Select borders of ICME events and related Forbush decreases
  • Perform in-situ analysis of ICMEs
  • Execute ForbMod best-fit procedures on selected events
  • Generate comprehensive analysis outputs and visualizations

 

G4VM: GEANT4 Virtual Machine for simulations of SOHO/Chandra EPHIN and Solar Orbiter HET

The G4VM (GEANT4 Virtual Machine) aims to make GEANT4 instrument simulations of SOHO/Chandra EPHIN and Solar Orbiter HET readily accessible.

It contains the corresponding GDML models along with a compatible GEANT4 application. The models incorporate the sensitive detectors of the instruments and the passive material shielding the detectors, represented with high precision. Each instrument is provided individually and with a spacecraft model that maps the spacecraft’s shielding material onto spherical shell segments with varying densities to account for directionality.

The GEANT4 application can be built independently but is provided in a configuration that works seamlessly within the recommended setup.

VDA: Velocity Dispersion Analysis of Solar Energetic Particle events

The VDA tool supports the semi-automatic application of Velocity Dispersion Analysis (VDA) to one or multiple Solar Energetic Particle (SEP) events. VDA uses the energy-dependent particle onset times to estimate the solar release time of the particles and their apparent propagation path length, assuming approximately simultaneous release and a common propagation path (see Kolympiris et al. 2023, Lintunen & Vainio 2004). Users can parameterize the provided Notebook by selecting the particle species, sensor, viewing directions, and other analysis options.

SPEARHEAD SEP-PACT (Solar Energetic Particle Analysis and Calculation Tool)

SEP-PACT (Solar Energetic Particle Analysis and Calculation Tool) is a software framework for the semi-automatic characterization of Solar Energetic Particle (SEP) events using data from the High Energy Telescope (HET) onboard Solar Orbiter. It calculates key event parameters, including onset time, peak time, peak flux, and fluence, for electron and proton observations. Users can combine HET energy channels, select different time resolutions, and use the available viewing directions. The derived parameters depend on the selected event interval and analysis configuration, allowing users to adapt the calculation to the characteristics of each SEP event.