solar-mach

The Solar MAgnetic Connection Haus (Solar-MACH) tool is a multi-spacecraft longitudinal configuration plotter

https://github.com/jgieseler/solar-mach

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

heliophysics heliosphere python solar-physics solar-system space space-physics streamlit streamlit-application streamlit-webapp
Last synced: 6 months ago · JSON representation ·

Repository

The Solar MAgnetic Connection Haus (Solar-MACH) tool is a multi-spacecraft longitudinal configuration plotter

Basic Info
Statistics
  • Stars: 17
  • Watchers: 2
  • Forks: 10
  • Open Issues: 7
  • Releases: 4
Topics
heliophysics heliosphere python solar-physics solar-system space space-physics streamlit streamlit-application streamlit-webapp
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Citation Zenodo

README.md

Solar MAgnetic Connection Haus tool

Open in Streamlit DOI Python

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:

```python

optional: create and activate virtual environment in python (alternatively use conda)

python3 -m venv env source env/bin/activate

install requirements with pip (alternatively use conda)

pip3 install -r requirements.txt

run the actual streamlit app

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:

bash pip install solarmach

or from conda using:

bash 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

Owner

  • Name: Jan Gieseler
  • Login: jgieseler
  • Kind: user
  • Location: Turku, Finland
  • Company: University of Turku

Citation (CITATION.cff)

# YAML 1.2
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
cff-version: 1.0.3
message: If you use this software, please cite it using these metadata.
title: Solar-MACH
doi: 10.5281/zenodo.10069803
authors:
- given-names: Jan
  family-names: Gieseler
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0003-1848-7067
- given-names: Nina
  family-names: Dresing
  affiliation: University of Turku
  orcid: https://orcid.org/0000-0003-3903-4649
- given-names: Johan
  family-names: Freiherr von Forstner
  name-particle: L.
  affiliation: Paradox Cat GmbH
- given-names: Athanasios
  family-names: Kouloumvakos
  orcid: https://orcid.org/0000-0001-6589-4509
  affiliation: Applied Physics Laboratory, Johns Hopkins University
version: 0.1.7
date-released: 2023-11-03
repository-code: https://github.com/jgieseler/Solar-MACH
license: BSD-3-Clause
preferred-citation:
  type: article
  authors:
  - given-names: Jan
    family-names: Gieseler
    orcid: https://orcid.org/0000-0003-1848-7067
  - given-names: Nina
    family-names: Dresing
    orcid: https://orcid.org/0000-0003-3903-4649
  - given-names: Christian
    family-names: Palmroos
    orcid: https://orcid.org/0000-0002-7778-5454
  - given-names: "Johan L."
    family-names: "Freiherr von Forstner"
  - given-names: "Daniel J."
    family-names: Price
    orcid: https://orcid.org/0000-0003-2672-5491
  - given-names: Rami
    family-names: Vainio
    orcid: https://orcid.org/0000-0002-3298-2067
  - given-names: Athanasios
    family-names: Kouloumvakos
    orcid: https://orcid.org/0000-0001-6589-4509
  - given-names: Laura 
    family-names: "Rodríguez-García"
    orcid: https://orcid.org/0000-0003-2361-5510
  - given-names: Domenico
    family-names: Trotta
    orcid: https://orcid.org/0000-0002-0608-8897
  - given-names: Vincent
    family-names: Génot
    orcid: https://orcid.org/0000-0002-7708-8077
  - given-names: Arnaud
    family-names: Masson
    orcid: https://orcid.org/0000-0002-5602-1957
  - given-names: Markus
    family-names: Roth
    orcid: https://orcid.org/0000-0002-1430-7172
  - given-names: Astrid
    family-names: Veronig
    orcid: https://orcid.org/0000-0003-2073-002X
  doi: 10.3389/fspas.2022.1058810
  url: http://dx.doi.org/10.3389/fspas.2022.1058810
  issn: 2296-987X
  journal: Frontiers in Astronomy and Space Sciences
  month: 2
  title: 'Solar-MACH: An open-source tool to analyze solar magnetic connection configurations'
  volume: 9
  year: 2023

GitHub Events

Total
  • Issues event: 5
  • Watch event: 3
  • Issue comment event: 3
  • Push event: 40
  • Pull request event: 5
  • Fork event: 4
  • Create event: 4
Last Year
  • Issues event: 5
  • Watch event: 3
  • Issue comment event: 3
  • Push event: 40
  • Pull request event: 5
  • Fork event: 4
  • Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 3
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 0.78
  • Average comments per pull request: 0.33
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 4
  • Pull requests: 3
  • Average time to close issues: 10 days
  • Average time to close pull requests: about 2 hours
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.25
  • Average comments per pull request: 0.33
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • jgieseler (7)
  • sapols (1)
  • AthKouloumvakos (1)
Pull Request Authors
  • zheyiding96 (1)
  • dependabot[bot] (1)
  • jgieseler (1)
Top Labels
Issue Labels
enhancement (5)
Pull Request Labels
dependencies (1) github_actions (1)

Dependencies

requirements.txt pypi
  • astroquery *
  • matplotlib *
  • numpy *
  • pyshorteners *
  • scipy *
  • streamlit *
  • sunpy ==2.0.7
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • cpina/github-action-push-to-another-repository main composite