Streamlit frontend to the PyPI package solarmach, used for solar-mach.github.io.
To install and start a local Streamlit server, run the following commands in your terminal:
# optional: create and activate virtual environment in python (alternatively use anaconda)
python3 -m venv env
source env/bin/activate
# install requirements with pip (alternatively use anaconda)
pip3 install -r requirements.txt
# run the actual streamlit app
streamlit run streamlit_app.py
Afterwards the app should open in your browser.
In addition, all the functionality is available in the streamlit-independent python package solarmach. It requires python >= 3.10 and can be installed either from PyPI using:
pip install solarmach
or from conda using:
conda install -c conda-forge solarmach
See https://github.com/jgieseler/solarmach for a more detailled description.
Please cite the following paper if you use Solar-MACH in your publication:
Gieseler, J., Dresing, N., Palmroos, C., von Forstner, J.L.F., Price, D.J., Vainio, R. et al. (2023). Solar-MACH: An open-source tool to analyze solar magnetic connection configurations. Front. Astronomy Space Sci. 9. doi:10.3389/fspas.2022.1058810