glue-solar documentation

glue-solar is a project to provide solar physics specific functionality to glue, to facilitate multi-instrument interactive visualization.

Installing and running

Requirements

For the requirements of glue, please refer to their official documentation on installing and running glue.

Installing glue-solar

In order to use glue with the glue-solar plugin, you will need to have both packages installed on your computer. For the time being before an official release, the only way to install glue-solar is to download with GitHub, where the repository for the package is hosted.

This assumes that you already have pip and a Python virtual environment created and active.

To download the entire glue-solar repository locally, first make sure you have Git installed locally, then to clone over HTTPS:

$ git clone https://github.com/glue-viz/glue-solar.git

After that, change directory (cd) to glue-solar:

$ cd glue-solar

Finally, do the following while at the root (highest level) of the glue-solar directory:

$ pip install -e .

This installs PyQt6: glue-solar needs Qt 6, and says so as glue starts under Qt 5. Where PyQt5 is installed too, set QT_API=pyqt6 before starting glue, as qtpy takes PyQt5 first.

The O IV density preset of the line ratio diagnostic needs fiasco from its git main, in the density extra:

$ pip install -e ".[density]"

fiasco downloads and builds the CHIANTI atomic database, a few GB, on its first use.

Starting up Glue

Once both glue and glue-solar have been properly installed, to start the application via the command line:

$ glue

This will launch the glue graphical user interface (GUI) from your terminal.

On Windows operating systems, installation creates an executable glue.exe file within the Python script directory (e.g., C:\Python312\Scripts). Windows users can create a desktop shortcut for this file upon installation

User Interface Guide

For a walk through of the user interface of glue, please refer to the getting started section of the glue documentation.

• User Guide
  • Loading and over-plotting AIA and HMI files as sunpy Maps
  • Browsing and Loading IRIS Level 2 Data
  • Opening SST CRISP and CHROMIS cubes
  • The quicklook
  • Line moments
  • Red-blue asymmetry
  • Mg II features
  • Dust and radiance
  • UV bursts
  • Viewer tools and windows
  • A guide to using glue’s 1D profile viewer to probe IRIS Level 2 data sets
  • Scripting with IRIS data
• Developer Documentation
  • Data Loader Customization Guide
  • Building the macOS app
  • Manual checks of the quicklook
• API Reference
  • glue_solar.sources.iris Module
  • glue_solar.sources.maps Module
  • glue_solar.sources.sst Module
  • glue_solar.sources.loaders.scan Module
  • glue_solar.quicklook Module
  • glue_solar.lines Module
  • glue_solar.regrid Module
  • glue_solar.sources.moments Module
  • glue_solar.sources.red_blue Module
  • glue_solar.sources.doppler Module
  • glue_solar.sources.mg_features Module
  • glue_solar.sources.line_ratio Module
  • glue_solar.sources.calibration Module
  • glue_solar.sources.bursts Module
• Release History
  • Full Changelog