solarviewer 1.2.0

SolarViewer - A comprehensive tool for visualizing and analyzing solar radio images

🌞 SolarViewer

A comprehensive Python toolkit for visualizing and analyzing solar radio images

Features • Installation • Quick Start • CLI • Documentation • Contributing

---

✨ Features

SolarViewer is a feature-rich desktop application designed for solar physics research. It supports FITS and CASA image formats with specialized tools for radio astronomy.

🔭 Multiple Viewer Modes

Viewer	Description
Standard Viewer	Full-featured multi-tab interface with comprehensive analysis tools, including helioprojective coordinate support
Napari Viewer	Lightweight, fast viewer for quick visualization

📊 Analysis & Visualization

• Statistical Analysis — Detailed statistics for images and selected regions
• 2D Gaussian Fitting — Fit Gaussian profiles to radio sources
• Elliptical Ring Fitting — Model ring-shaped emission features
• Region Selection — Rectangle and ellipse tools for region-of-interest analysis
• Multiple Colormaps — Choose from scientific colormaps with linear, log, sqrt, and custom stretches
• Stokes Parameters — Full polarization support (I, Q, U, V, L, Lfrac, Vfrac, PANG)

🌐 Data Access & Downloads

• Remote Access (SSH/SFTP) — Browse and open files directly from remote servers with local caching
• Helioviewer Browser — Browse and download images from NASA's Helioviewer API with time-series playback
• Solar Data Downloader — Download data from SDO/AIA, IRIS, SOHO, GOES SUVI, STEREO, and GONG
• Radio Data Downloader — Access solar radio observation archives
• Solar Activity Viewer — Browse solar events (flares, CMEs, active regions) with real-time data

🎬 Video Creation

• Time-lapse Videos — Create MP4 videos from image sequences
• Contour Overlays — Overlay radio contours on EUV/optical base images
• Custom Annotations — Add timestamps, colorbars, and min/max plots
• Preview Mode — Real-time preview before rendering

🔧 Advanced Tools

• Log Console — Internal console to view application logs and debugging information
• LOFAR/SIMPL Support — Calibration table visualizer, dynamic spectra viewer, pipeline log viewer
• Coordinate Transformations — Convert between RA/Dec and helioprojective coordinates
• Phase Center Tool — Shift image phase centers for radio interferometry data
• Export Options — Export to FITS, CASA image, PNG, and region files

---

📦 Installation

Prerequisites

• Python 3.9 or higher
• pip package manager
• CASA data directory: The ~/.casa/data folder must exist for CASA to work properly. Create it with:

  mkdir -p ~/.casa/data
  

Note: No other manual installation is required — all dependencies are installed automatically via pip.

Recommended: Virtual Environment

It is highly recommended to install SolarViewer in a virtual environment to avoid conflicts with system packages.

# Create a virtual environment
python3 -m venv ~/.sv

# Activate the environment
source ~/.sv/bin/activate

Once the virtual environment is active, proceed with the installation below.

💡 Pro Tip: After running sv --install (see Desktop Integration below), you won't need to manually activate the environment to launch the application!

Install from PyPI

pip install solarviewer

Install from Source

git clone https://github.com/dey-soham/solarviewer.git
cd solarviewer
pip install -e .

Desktop Integration

After installation, you can create a desktop entry and icon (Linux) or an application bundle (macOS) to launch SolarViewer from your application menu:

# Install desktop shortcuts and icons
solarviewer --install
# or
sv --install

To remove the desktop integration later:

solarviewer --uninstall

Dependencies

View core dependencies

Package	Version	Purpose
PyQt5	≥5.15.0	GUI framework
matplotlib	≥3.5.0	Plotting and visualization
numpy	≥1.20.0	Numerical operations
astropy	≥5.0.0	FITS handling, coordinates
scipy	≥1.7.0	Scientific computing
sunpy	≥5.0.0	Solar physics tools
casatools	≥6.4.0	CASA image support
casatasks	≥6.4.0	CASA tasks
napari	≥0.4.16	Fast image viewer

---

🚀 Quick Start

Launch the Viewer

# Standard viewer
solarviewer
# or
sv

# Open a specific file
solarviewer path/to/image.fits

# Fast Napari viewer
solarviewer -f path/to/image.fits

LOFAR Tools

viewcaltable       # Calibration table visualizer
viewds             # Dynamic spectra viewer
viewlogs           # Pipeline log viewer

Other Tools

viewsolaractivity  # Solar events browser
heliobrowser       # Helioviewer browser

---

💻 Command Line Interface

Standard Viewer (solarviewer / sv)

solarviewer [OPTIONS] [IMAGEFILE]

Options:
  -f, --fast        Launch fast Napari viewer
  --install         Install desktop integration
  --uninstall       Uninstall desktop integration
  --light           Start with light theme
  -v, --version     Show version and exit
  -h, --help        Show help message

---

📚 Documentation

User Interface Overview

Standard Viewer Controls

File Controls

• Open Directory — Load a folder of solar radio images
• Open FITS File — Load a single FITS file
• Export Figure — Save current view as image
• Export as FITS — Export data as FITS file

Display Controls

• Colormap — Choose visualization colormap
• Stretch — Linear, log, sqrt, power-law options
• Gamma — Adjust power-law exponent
• Min/Max — Manual or auto display range

Region Tools

• Rectangle/Ellipse Selection — Select regions for analysis
• Export Region — Save as CASA region file
• Export Sub-image — Extract region as new image

Analysis Tools

• Fit 2D Gaussian — Gaussian source fitting
• Fit Elliptical Ring — Ring model fitting
• Image Statistics — Full image statistics
• Region Statistics — Selected region statistics

---

🏗️ Project Structure

solarviewer/
├── solar_radio_image_viewer/
│   ├── main.py                 # Entry point
│   ├── install_utils.py        # Desktop integration (install/uninstall)
│   ├── viewer.py               # Standard viewer
│   ├── assets/                 # Icons and resources
│   ├── helioprojective.py      # Coordinate conversions
│   ├── helioprojective_viewer.py
│   ├── helioviewer_browser.py  # Helioviewer API browser
│   ├── napari_viewer.py        # Fast viewer
│   ├── video_dialog.py         # Video creation UI
│   ├── create_video.py         # Video rendering
│   ├── video_utils.py          # Video utilities
│   ├── noaa_events/            # Solar events browser
│   ├── solar_data_downloader/  # SDO/AIA, IRIS, etc.
│   ├── radio_data_downloader/  # Radio data archives
│   ├── solar_context/          # Real-time solar data
│   ├── remote/                 # Remote file access (SSH/SFTP)
│   ├── from_simpl/             # LOFAR/SIMPL tools
│   ├── learmonth-py/           # Learmonth data downloader
│   ├── move_phasecenter.py     # Phase center correction tool
│   ├── tutorial.py             # Tutorial
│   ├── dialogs.py              # Application dialogs
│   ├── splash.py               # Splash screen
│   ├── log_console.py          # Internal log viewer
│   ├── searchable_combobox.py  # Custom combobox widget
│   ├── norms.py                # Image normalization
│   ├── utils.py                # Utility functions
│   ├── utils/                  # Additional utilities (updater, limiter)
│   ├── version.py              # Version information
│   └── styles.py               # UI themes (light/dark)
├── resources/                  # Desktop integration resources
├── setup.py
├── requirements.txt
├── README.md
├── LICENSE
└── RELEASE_NOTES.md

---

🤝 Contributing

Contributions are welcome! Whether you're fixing bugs, adding features, or improving documentation, we appreciate your help.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📄 License

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

---

🙏 Acknowledgments

This project builds on the excellent work of the solar physics and radio astronomy communities:

Core Libraries

• SunPy — Solar physics data analysis in Python
• Astropy — Core astronomy library for FITS, coordinates, and units
• CASA — Common Astronomy Software Applications for radio astronomy
• Napari — Fast n-dimensional image viewer

GUI & Visualization

• PyQt5 — Python bindings for Qt GUI framework
• Matplotlib — Publication-quality plotting
• NumPy — Fundamental package for scientific computing
• SciPy — Scientific algorithms and mathematics

Data Sources & APIs

• Helioviewer — NASA/ESA solar image browser and API
• SolarMonitor — Real-time solar activity monitoring
• NOAA SWPC — Space Weather Prediction Center solar event data
• SDO/AIA — Solar Dynamics Observatory
• JSOC — Joint Science Operations Center for SDO data
• VSO — Virtual Solar Observatory

Community

• The solar physics group at the National Centre for Radio Astrophysics for feedback and testing

---

👨‍💻 Author

Soham Dey — [e-mail] — @dey-soham

---

_{Built with ❤️ for solar physics research}