Skip to main content

The PgLis model

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

PgLis is a model developed to forecast the flux of solar-modulated galactic cosmic-rays near Earth.

We modelled the different transport parameters that cosmic rays experience as they traverse the heliosphere to arrive at Earth (article link available soon), parametrised them as functions of solar activity, using the widely available sunspot number as a proxy (see NOAA), which we delay according to Tomassetti et al. (2022) to account for transport time.

This allows us to estimate the fluxes of cosmic nuclei near Earth, from Hydrogen to Nickel, as they evolve with solar activity.

Prediction_AMS_SSN

This package is a Python implementation that interpolated between the pre-computed tables available in Zenodo. It downloads the data from Zenodo and the sunspot numbers from NOAA.

Model Heatmap
Flux model for both solar magnetic polarities, for cosmic hydrogen.

Scientific background

The modulation of galactic cosmic rays, driven by the evolution of the heliospheric magnetic field, strongly influences the intensity of cosmic rays reaching near-Earth space. Characterizing this process is crucial both for advancing our understanding of cosmic ray transport and for assessing radiation exposure and related hazards in space environments.

Here we present the PgLis model, a newly developed forecasting framework built upon our previous work, designed for the long-term forecasting of galactic cosmic-ray fluxes.

The model is the result of a collaboration between the Università degli Studi di Perugia (Pg) and the Laboratório de Instrumentação e Física Experimental de Partículas in Lisbon (Lis), and is based on a numerical description of charged-particle transport in the heliosphere and its dependence on solar activity.

The PgLis model has been validated using multi-species flux measurements from space-based instruments such as PAMELA, AMS-02, and ACE. Its strategy is based upon Hilbert-Huang transform filtering and cross-correlation between delayed solar proxies and effective model parameters.

It demonstrates a demonstrably good performance across a broad multichannel and multi-species testing dataset, spanning different energy ranges and solar phases. These advancements enhance its applicability to space radiation monitoring and forecasting. Furthermore, when coupled with solar-proxy forecasting models, PgLis enables decadal-scale predictions of galactic cosmic-ray fluxes, thereby supporting long-term planning and radiation-risk assessment for future space missions.

Usage examples

More examples can be found in the tutorial.

Getting the flux for a given time

# setup model
model = pglis.solar_mod()

# defining the time - 2001/06/01
t = datetime.datetime(2001, 6, 1).timestamp()

# getting the flux as a dataframe
df = model.get_dataframe_flux_vs_energy(Z=1, time=t)

Installation

From GitHub

To install this package you can run the following commands:

# download the repository
git clone git@github.com:davidpelosi21/PgLis.git

# install the package
python3 -m pip install .

From PyPi

python3 -m pip install pglis

Uninstalling the package

To remove the package you must first remove the data, this can be done by running a command that comes bundled with the package:

pglis-cleanup

To uninstall the package, regardless of the data, you can simply run the following command:

python3 -m pip uninstall pglis

Authors

David Pelosi1,2, Fernando Barão3,4, Bruna Bertucci1,2, Emanuele Fiandrini1,2, Miguel Orcinha2 and Nicola Tomassetti1,2

1 Università degli Studi di Perugia, Perugia 06100, Italy
2 INFN - Perugia, Perugia 06100, Italy
3 Laboratório de Instrumentação e Física Experimental de Partículas, Lisboa 1000, Portugal
4 Instituto Superior Técnico, Lisboa 1049, Portugal

PgLis Logo

Maintainers

David Pelosi1,2 E-mail
Miguel Orcinha2 E-mail

How to cite

This package was created to simplify and systematise the access to the flux model presented in the article Pelosi et al. (2026) The PgLis Model: A Tool for Long-Term Galactic Cosmic Ray Forecasting, Phys. Rev. D, (under review).

The heatmaps with the discretised model used in this package can be found in Zenodo.

Acknowledgements

This work as been developped with support from Agenzia Spaziale Italiana (ASI), under ASI-UniPG 2019-2-HH.0, ASI-INFN 2019-19 HH.0, its amendment 2021-43 HH.0, the Italian Ministry of University and Research (MUR) through the program "Dipartimenti di Eccellenza 2023-2027" and Fundação para a Ciência e Tecnologia (FCT) under grant 2024.00992.CERN, Portugal.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pglis-1.0.2.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pglis-1.0.2-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file pglis-1.0.2.tar.gz.

File metadata

  • Download URL: pglis-1.0.2.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for pglis-1.0.2.tar.gz
Algorithm Hash digest
SHA256 87f90080e48a600cec44d6a471a0503df0b662956ac7aa9eb71acc3cadbae104
MD5 e8b5952fe32501a5e90826200dfa52cd
BLAKE2b-256 93dcf8ed433029f1f47b8af4dfa8ddc140f3269ff6e02ab9e420b6236b1a207c

See more details on using hashes here.

File details

Details for the file pglis-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: pglis-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for pglis-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 51210dc2495d6bc638c581bded33e56833c75dde517249d6572b1bb0d98c9941
MD5 796fb9853856cf313dd9f6db8f7e1319
BLAKE2b-256 9985452506b9db0fe01cd7609b8a6994a54f1e39db8863b8c9aa0801168d21bb

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page