6. Python Interface

Welcome to the documentation of PYSPEX, the Python interface to SPEX. Since version 3.06.00 we provide a Python interface layer to the SPEX program. This documentation section explains how to use this interface, which is an alternative for the standard command-line interface of SPEX.

Note

As an alternative to some auxilliary programs of SPEX (e.g. trafo), we offer a separate Python package called pyspextools. Please see the Pyspextools documentation for more information.

6.1. Basic commands

• 6.1.1. Basic usage of PYSPEX
  • 6.1.1.1. Start a PYSPEX session
  • 6.1.1.2. The command function
• 6.1.2. Basic PYSPEX commands
  • 6.1.2.1. Data related commands
  • 6.1.2.2. Model related commands
  • 6.1.2.3. Ascdump commands
  • 6.1.2.4. Optimization commands
  • 6.1.2.5. Plot commands
  • 6.1.2.6. Log commands

6.2. Analysis threads & other tricks

• 6.2.1. Jupyter Notebooks
• 6.2.2. Astropy units and tables
• 6.2.3. Multiprocessing with PYSPEX

6.3. Advanced class descriptions

• 6.3.1. Session class structure
  • 6.3.1.1. Session class commands
• 6.3.2. Data class structure
  • 6.3.2.1. Spectral & response data
  • 6.3.2.2. Spectral binning and data selection
  • 6.3.2.3. Simulate spectra
• 6.3.3. Model class structures
  • 6.3.3.1. Model
  • 6.3.3.2. Sector
  • 6.3.3.3. Component
  • 6.3.3.4. Parameter
  • 6.3.3.5. Abundance
  • 6.3.3.6. Aerror
  • 6.3.3.7. Distance
  • 6.3.3.8. Energy grids
  • 6.3.3.9. Fluxes and luminosities
  • 6.3.3.10. Ionisation balance
  • 6.3.3.11. Ion selection
  • 6.3.3.12. Model spectra
  • 6.3.3.13. DEM Modeling
  • 6.3.3.14. Plasma parameters
• 6.3.4. Optimization functions
  • 6.3.4.1. Fitting spectra
  • 6.3.4.2. Error calculation
• 6.3.5. Plot functions
  • 6.3.5.1. Model spectrum plots
  • 6.3.5.2. Data plots
  • 6.3.5.3. Effective area plots
• 6.3.6. Ascdump class
• 6.3.7. Logging commands