Python API 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.

Basic commands

• Basic usage of PYSPEX
  • Before you start
  • Starting a PYSPEX session
  • The command function
• Basic PYSPEX commands
  • Data related commands
  • Model related commands
  • Ascdump commands
  • Optimization & Simulation commands
  • Plot commands
  • Log commands
  • Reset command

Analysis threads & other tricks

• Jupyter Notebooks
• Astropy units and tables

Advanced class descriptions

• Spex class structure
  • PYSPEX sessions
  • Spex class commands
• Data class structure
  • Spectral & response data
• Model class structures
  • Model
  • Sector
  • Component
  • Parameter
  • Abundance
  • Aerror
  • Distance
  • Energy grids
  • Fluxes and luminosities
  • Ionisation balance
  • Ion selection
  • Model spectra
  • Plasma parameters
• Optimization & Simulation functions
  • Fitting spectra
  • Error calculation
  • Simulating spectra
• Plot functions
  • Model spectrum plots
  • Model spectrum plots with components
  • Data plots
  • Data component plots
  • Effective area plots
  • Model transmission plots
• Ascdump class
  • Ascdump
• Logging commands
  • Log