PyThea’s Documentation

python pypi Release Date License: GPL v3 https://github.com/AthKouloumvakos/PyThea/actions/workflows/pytest.yml/badge.svg

PyThea is an open-source software package that can be used to reconstruct the 3D structure of Coronal Mass Ejections (CMEs) and shock waves and determine their kinematics using remote-sensing observations. The tool implements the Graduated Cylindrical Shell (GCS) model that can be used to reconstruct CMEs and two geometrical models, namely a spheroid and ellipsoid model to reconstruct shock waves. It also implements remote-sensing observations from multiple viewpoints such as the Solar and Heliospheric Observatory (SoHO) and Solar Terrestrial Relations Observatory (STEREO).

Installing and Running PyThea

To install and run PyThea, Python >=3.8 or later is required. We recommend creating a virtual environment using conda and installing PyThea with pip.

# Create the virtual environment
conda create --name PyThea python=3.9

# Activate the environment
conda activate PyThea

# Install the required packages using pip
pip install PyThea

 # Run PyThea as Streamlit App.
PyThea streamlit

You can find more information in Installing PyThea and Run the Application sections.

Acknowledging or Citing PyThea

If you use PyThea for scientific work or research presented in a publication, please cite it by acknowledging in the main text its use and include the following citation:

Note

“Athanasios Kouloumvakos et al. (2022). PyThea: An open-source software package to perform 3D reconstruction of coronal mass ejections and shock waves, Front. Astron. Space Sci. 9:974137. (DOI: 10.3389/fspas.2022.974137 <https://www.frontiersin.org/articles/10.3389/fspas.2022.974137/>)”.

Also include in the methods or acknowledgement section the follorwing, changing the v?.?.? to the version you have used,

Note

“This research has made use of PyThea v?.?.?, an open-source and free Python package to reconstruct the 3D structure of CMEs and shock waves (Zenodo: https://doi.org/10.5281/zenodo.5713659).”. zenodo

You can find more information in Acknowledging or Citing section.

The mythology of Thea

In Greek mythology, Thea, also called Euryphaessa “wide-shining”, is the Titaness of sight and the shining light of the clear blue sky. Her brother/consort is Hyperion, a Titan and god of the sun, and together they are the parents of Helios (the Sun), Selene (the Moon), and Eos (the Dawn).

Reference: