Solar MAgnetic Connection Haus tool

Streamlit frontend to the PyPI package solarmach, used for solar-mach.github.io.

Installation

You can use either a venv-based environment or a conda environment.

Option 1: Python venv environment

To install the requirements, run the following commands in your terminal:

# create and activate virtual environment named "solarmach" in python
python3 -m venv solarmach
source solarmach/bin/activate

# install requirements with pip
pip3 install -r requirements.txt

Option 2: Conda environment

Alternatively, you can use conda:

# create and activate virtual environment named "solarmach" in conda
conda create -n solarmach python=3.14
conda activate solarmach

# install requirements with pip inside the conda environment
pip install -r requirements.txt

Start the Streamlit app

After activating your chosen environment (source solarmach/bin/activate or conda activate solarmach), start a local Streamlit server with:

streamlit run streamlit_app.py

Afterwards the app should open in your browser.

Python package

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.

Contributing

Contributions to this project are very much welcome and encouraged! Contributions to the streamlit web-version that is used for solar-mach.github.io can take the form of issues to report bugs and request new features or pull requests to submit new code.

Please make contributions that are general to the solarmach package and not specific to the streamlit web-version in the corresponding repository at github.com/jgieseler/solarmach.

Citation

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