.. SPDX-FileCopyrightText: 1992-2026 NWO-I/SRON Space Research Organisation Netherlands
..
.. SPDX-License-Identifier: CC-BY-4.0

.. _sec:pyspexidx:

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
  <https://spex-xray.github.io/pyspextools/>`_ for more information.

Basic commands
--------------

.. toctree::
   :maxdepth: 2

   pythonapi/spex
   pythonapi/commands

Analysis threads & other tricks
-------------------------------

.. toctree::
   :maxdepth: 1

   pythonapi/threads
   pythonapi/astropy

Advanced class descriptions
---------------------------

.. toctree::
   :maxdepth: 2

   pythonapi/session
   pythonapi/data
   pythonapi/model
   pythonapi/optimize
   pythonapi/plot
   pythonapi/ascdump
   pythonapi/log