SPEX 4.0 documentation

Contents:

  • News
  • Install
    • Conda/Mamba
    • Install packages
    • Activate Python
    • Compile from source
    • Run in Docker
  • Using SPEX
    • General examples
      • How to run SPEX
      • How to convert spectra to SPEX format
    • Analysis threads
      • Fitting a CCD spectrum
      • Modeling particle background
      • Fitting interstellar dust absorption
      • Import UV/Optical data
      • PION setup for AGN warm absorber
      • PION setup for emission and absorption features in AGN
      • Fitting two different spectra simultaneously
      • How to use the SPEX user model
        • Use any Xspec model in SPEX
        • Use local Xspec model ismabs in SPEX
    • Performance
      • Optimizing model performance
    • Exercises
      • Powerlaw
      • Powerlaw with a Gaussian line
      • Statistics, binning and more
      • Stellar Spectra
      • Supernova remnants
      • Relativistic lines
      • AGN winds
  • Command syntax
    • Abundance: standard abundances
    • Aerror: Estimate atomic data errors for model parameters
    • Ascdump: ascii output of plasma and spectral properties
    • Ascdump output table properties
    • Bin: rebin the spectrum
    • Calculate: evaluate the spectrum
    • Comp: create, delete and relate spectral components
    • Data: read response file and spectrum
    • DEM: differential emission measure analysis
    • Distance: set the source distance
    • Egrid: define model energy grids
    • Elim: set flux energy limits
    • Error: Calculate the errors of the fitted parameters
    • Fit: spectral fitting
    • Ibal: set type of ionisation balance
    • Ignore: ignoring part of the spectrum
    • Ion: select ions for the plasma models
    • Log: Making and using command files
    • Menu: Menu settings
    • Model: show the current spectral model
    • Multiply: scaling of the response matrix
    • Obin: optimal rebinning of the data
    • Par: Input and output of model parameters
    • Plot: Plotting data and models
    • Quit: finish the program
    • Rbin: optimal rebinning of the data and response, including saving
    • Reset: Reset the data and/or model
    • Sector: creating, copying and deleting of a sector
    • Shiftplot: shift the plotted spectrum for display purposes
    • Simulate: Simulation of data
    • Step: Grid search for spectral fits
    • Syserr: systematic errors
    • System: call system executables
    • Use: reuse part of the spectrum
    • Var: various settings for the plasma models
    • Vbin: variable rebinning of the data
    • Watch: track time and subroutines
  • Spectral models
    • Absm: Morrison & McCammon absorption model
    • Amol: interstellar dust absorption model
    • APEC: collisional ionisation equilibrium model (External)
    • Bb: blackbody model
    • Cf: isobaric cooling flow differential emission measure model
    • Cie: collisional ionisation equilibrium model
    • Clus: projected cluster model
    • Comt: comptonisation model
    • CX: model for charge exchange plasmas
    • Dabs: dust absorption model
    • Dbb: disk blackbody model
    • Delt: delta line model
    • Dem: differential emission measure model
    • Dust: dust scattering model
    • Ebv: Galactic interstellar extinction model
    • Etau: simple transmission model
    • Euve: EUVE absorption model
    • File: model read from a file
    • Gain: Modify the energy scale of the model to compensate instrumental gain errors
    • Gaus: gaussian line model
    • Hot: collisional ionisation equilibrium absorption model
    • Hyd: model with user-own hydrodynamical simulation
    • Knak: segmented power law transmission model
    • Laor: relativistic line broadening model
    • Line: transmission model for a single spectral line
    • Lpro: spatial broadening model
    • Mbb: modified blackbody model
    • Musr: User defined multiplicative model
    • Neij: non-equilibrium ionisation jump model
    • Pdem: DEM models
    • Pion: SPEX photoionised plasma model
    • Pow: power law model
    • Reds: redshift model
    • Refl: reflection model
    • Rrc: radiative recombination continuum model
    • Slab: thin slab absorption model
    • Spei: relativistic line broadening model
    • Spln: spline continuum model
    • SSD: Shakura-Sunyaev disk model
    • Tpho: Time-dependent, non-equilibrium, photoionised plasma model
    • User: User defined model
    • Vblo: rectangular velocity broadening model
    • Vcom: Compton shoulder broadening model
    • Vgau: gaussian velocity broadening model
    • Vpro: velocity profile broadening model
    • Warm: continuous photoionised absorption model
    • Wdem: power law differential emission measure model
    • Xabs: photoionised absorption model
  • Plotting reference
    • Plot devices
    • Plot types
    • Plot colours
    • Plot line types
    • Plot text
    • Plot captions
    • Plot symbols
    • Plot axis units and scales
    • Plot asciidump file format
  • Spextools
    • Trafo
    • Stepcontour
    • Xabsinput
    • Hydro driver
    • Rgsvprof
    • RGS_fluxcombine
    • RGS_fmat
    • Uvtospex
    • Calling SPEX from Fortran
  • Python API Interface
    • Basic usage of PYSPEX
    • Basic PYSPEX commands
      • Data related commands
      • Model related commands
      • Ascdump commands
      • Optimization & Simulation commands
      • Plot commands
      • Log commands
      • Reset command
    • Jupyter Notebooks
    • Astropy units and tables
    • Spex class structure
    • Data class structure
    • Model class structures
    • Optimization & Simulation functions
    • Plot functions
    • Ascdump class
    • Logging commands
  • Fortran API Interface
  • Help & troubleshooting
    • Commandline help
    • Solving SPEX problems
    • Find known issues
    • Report issues
  • SPEX Theory
    • SPEX Atomic Code & Tables
      • The SPEX Atomic Code & Tables (SPEXACT)
      • Plasma model in SPEX 3.0
      • Absorption model theory
      • Atomic database for the absorbers
      • Non-equilibrium ionisation (NEI) calculations
      • Non-thermal electron distributions
      • Supernova remnant model theory
    • SPEX 2 notation of atomic transitions
    • Modelling and fitting
      • Calculating models on grids
      • Different types of spectral components
      • Sectors and regions
      • Spectral Fitting
      • Testing model significance
    • Optimal definition of respons matrices
    • Definition of the micro-turbulent velocity in SPEX
    • Supernova remnant model theory
  • Changelog
  • Credits
Theme by the Executable Book Project
Contents
  • Overview
  • Syntax
  • Examples

Menu: Menu settings¶

Overview¶

When command lines are typed, it frequently happens that often the first keywords are identical for several subsequent lines. This may happen for example when a plot is edited. SPEX offers a shortcut to this by using the menu command.

Syntax¶

The following syntax rules apply:

menu none : Quit the current menu text settings (i.e., return to the default spex prompt).
menu text #a : For all following commands, the text string #a will be appended automatically before the following commands.

Examples¶

menu text plot : All following commants will get the “plot” keyword put in front of them. So if the next commant would be “plot dev xs” it is sufficient to type “dev xs” instead.
menu none : Return to the normal SPEX prompt.
menu text "par 1 2" : All following commands wil get the “par 1 2” keywords put in front of them. The next command could be “t val 4.”, which will be expanded to the full “par 1 2 t val 4.” to set the temperature of sector 1, component 2 to 4 keV. Note that here the text has three keywords (par, 1, 2) and hence it has to be put between “”, to indicate that it is a single text string. If there is only one keyword, these “” are not necessary.

previous

Log: Making and using command files

next

Model: show the current spectral model

By NWO-I/SRON Space Research Organisation Netherlands
© Copyright 1992-2026, NWO-I/SRON Space Research Organisation Netherlands, CC-BY-4.0.