x-cme

Fitting app for ICME's - Developed by Martí Massó Moreno at NASA Goddard

https://github.com/x-cme/x-cme

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 4 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.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Fitting app for ICME's - Developed by Martí Massó Moreno at NASA Goddard

Basic Info
  • Host: GitHub
  • Owner: X-CME
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 1.82 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 6
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

X-CME

License: MIT
DOI

Fitting app for interplanetary Coronal Mass Ejections (ICMEs)
Developed by Martí Massó Moreno at NASA Goddard


🚀 Overview

X-CME is a Python/Streamlit application for interactive, reproducible analysis of Coronal Mass Ejections (CMEs) and their embedded magnetic flux ropes using in‑situ spacecraft data. Key features include:

  • Flux Rope Analysis with two physical variants (purely radial; radial + azimuthal)
  • Real-time parameter sliders for geometry, field configuration, and propagation speed
  • Publication‑quality plots of magnetic field and current density distributions
  • Interactive 3D visualizations of flux ropes and CME propagation paths

🔧 Installation

  1. Clone this repository
    bash git clone https://github.com/X-CME/X-CME.git cd X-CME
  2. Create & activate a virtual environment
    bash python3 -m venv venv source venv/bin/activate # macOS/Linux venv\Scripts\activate # Windows
  3. Install dependencies
    bash pip install -r requirements.txt

▶️ Usage

Local

bash streamlit run app/streamlit_app.py

Open your browser at http://localhost:8501 to interact with X-CME locally.

Streamlit Community Cloud

  1. Push your code to GitHub and ensure you have a tagged release (v0.1.5).
  2. Go to https://share.streamlit.io, connect your GitHub account, select X-CME/X-CME, branch main, and file app/streamlit_app.py.
  3. Click Deploy and share the generated URL (e.g., https://share.streamlit.io/X-CME/X-CME/main/app/streamlit_app.py).

📑 How to cite

If you use X-CME in your research, please cite it as follows:

bibtex @software{MassoMoreno2025, title = {{X-CME: Fitting App for ICME’s}}, author = {Massó Moreno, Martí}, year = {2025}, version = {v0.1.5}, doi = {10.5281/zenodo.15306061}, url = {https://github.com/X-CME/X-CME} }

Metadata is also available in CITATION.cff.


📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Owner

  • Name: X-CME
  • Login: X-CME
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software in your research, please cite it as follows."
title: "X-CME: Fitting App for ICME’s"
version: "v0.1.0"
date-released: "2025-04-29"
authors:
  - family-names: "Massó Moreno"
    given-names: "Martí"
doi: "10.5281/zenodo.15306061"
url: "https://github.com/X-CME/X-CME"

GitHub Events

Total
  • Release event: 5
  • Member event: 1
  • Push event: 74
  • Pull request event: 64
  • Fork event: 1
  • Create event: 6
Last Year
  • Release event: 5
  • Member event: 1
  • Push event: 74
  • Pull request event: 64
  • Fork event: 1
  • Create event: 6