PyThea 0.6.2.dev6

PyThea: A software package to reconstruct the 3D structure of CMEs and shock waves

PyThea: A software package to reconstruct the 3D structure of CMEs and shock waves

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).

💾 Installation

We recommend, to create a virtual environment for PyThea and installing the package from PyPI using pip.

If you use Anaconda or Miniconda (which we also recommend) you can make an create a virtual environment using conda and then install PyThea using from PyPI using pip. In the terminal do the following:

# Create a virtual environment. Use python=3.8 or 3.9
conda create --name PyThea python=3.9

# Activate the environment
conda activate PyThea

# install the required packages using pip3
pip3 install PyThea

# Run locally _PyThea_ application running PyThea streamlit (see next step)
PyThea streamlit

# When you are done you can deactivate the virtual environment
conda deactivate

If conda is not your favorite way of working or making creating a virtual environments in python, then you can manually create an environment and install PyThea with pip as previously shown. For example you can do the following:

# Create a virtual environment.
python3 -m venv PyThea

# Activate the environment
source PyThea/bin/activate

# install the required packages using pip3
pip3 install PyThea

# Run locally _PyThea_ application running PyThea streamlit (see next step)
PyThea streamlit

# When you are done you can deactivate the virtual environment
deactivate

At the directory where the terminal is open, this method will create a folder named /PyThea and install PyThea and all the required packages inside.

🐾 Run locally the PyThea application

After installing PyThea software package you can run the application using the terminal.

If the environment is not active then use conda activate PyThea to activate this and then run PyThea with

PyThea streamlit

The application should now open in the default browser!

Deactivate the environment when you finish.

📙 Usage

Complete documentation of the PyThea is under construction.

📦 Useful Python packages

• SunPy: The community-developed, free and open-source solar data analysis environment for Python.
• AstroPy: The Astropy Project is a community effort to develop a single core package for Astronomy in Python.

📜 Acknowledging or Citing PyThea

If you use PyThea for scientific work or research presented in a publication, please mention it in the main text and cite the package using the following: "Athanasios Kouloumvakos (2022). PyThea: A software package to reconstruct the 3D structure of CMEs and shock waves. (Zenodo: https://doi.org/10.5281/zenodo.5713659)". Additionally, add the in the methods or acknowledgements section the following: "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).". To acknowledge PyThea in posters or talks include the project logo or icon. PyThea has a strong dependency to SunPy and AstroPy Python packages, consider citing these packages as well.

ⓘ 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).