Documentation for the CLEDB Distribution

---

Purpose:

The Coronal Line Emission DataBase inversion is a public Python based tool and pipeline that is used to infer magnetic field information from SpectroPolariemtric observations of the Solar Corona. This document describes the main concepts, functions, and variables, comprising the CLEDB inversion algorithm for inverted coronal magnetic fields.

---

Authors and Contact:

Alin Paraschiv and Philip Judge

– High Altitude Observatory NCAR|UCAR

– National Solar Observatory, AURA

arparaschiv at ucar edu or paraschiv.alinrazvan+cledb at gmail

---

Caution

Vector coronal magnetometry is not yet advanced enough as to recover HMI-like magnetograms. A user should not expect such a product yet. Solution degeneracies exist, and the user is required to make a decision on how to interpret the inversion outputs and which products to utilize for their science.

Danger

This setup should be considered at best a beta-level release. This setup tackles a problem for which currently no complete observation data exists and where a complex forward-model + inversion is required. Bugs or unintentional bad outcomes will still exist at this point in time. Please get in touch with us about any “feature” you discover.

Note

Last updated at the *update-readthedocs* commit tag.

Contents:

• Synopsis and Motivation
  • Synopsis
  • Motivation for the CLEDB approach
  • List of Relevant Publications
• Module Overview
  • Algorithm Flowchart Definitions
  • The CLEDB Modules
  • The Python Modules
• Installation and Run Instructions
  • Code Distribution Download
  • A CLEDBenv Python Environment
  • Basic Run Example
  • Headless Slurm Runs Overview
  • Example Test Data
• Input Variables and Parameters
  • Input Data and Metadata
  • Ctrl. Parameters ctrlparams.py Class
    • General Parameters
    • PREPINV Parameters
    • PROC Parameters
    • Numba Jit Parameters
  • Constants constants.py Class
    • Physical Constants
    • Ion Specific Constants
• CLEDB_BUILD - Database Generation
  • CLEDB_BUILD Configuration
    • DB.INPUT Parameters
  • The CLEDB_BUILD Job Script
  • CLEDB_BUILD Output
• CLEDB_PREPINV - Pre-processing
  • CLEDB_PREPINV Module Functions
  • CLEDB_PREPINV Main Variables
• CLEDB_PROC - Analysis and Inversion
  • The SPECTRO_PROC Function
    • SPECTRO_PROC Main Functions
    • SPECTRO_PROC Main Variables
  • The BLOS_PROC Function
    • BLOS_PROC Main Functions
    • BLOS_PROC Main Variables
  • The CLEDB_INVPROC Function
    • CLEDB_INVPROC Main Functions
    • CLEDB_INVPROC Main Variables
• Output Products
  • Output Variable Overview
  • Tentative Issuemask Implementation
• Thorough Readme Files
  • MAIN README
    • CLEDB Coronal Magnetic Field Database Inversion
  • README-RUNDB
    • CLEDB Parallel Database Generator
  • README-SLURM
    • CLEDB Research Computing Runs
• List of changes and TODO tasks
  • CLEDB UPDATES and TODO list
• Glossary