Skip to main content

Python wrapper for the XMM-Newton Science Analysis System (SAS)

Project description

pxsas is a simple Python 3 wrapper for the XMM-Newton Science Analysis System (SAS).


pxsas needs a working SAS installation. SAS has to be initialized before importing pxsas into your python environment.

A note about SAS 17.0.0 and above

Starting with version 17.0.0, the SAS installation procedure creates its own python environment for running some tasks. This is the system’s default python environment after the initialization of SAS. You can install pxsas in this environment, but this is extremely NOT recomended. Instead, you can redefine your PATH after SAS initialization like this (in bash):

export PATH="/path/to/my/python:$PATH"


pxsas can be easily installed using pip:

pip install pxsas


A simple example of using pxsas:

>>> import logging
>>> import os
>>> import pxsas

>>> logging.getLogger().setLevel(logging.INFO)

# Show SAS version used by pxsas
>>> pxsas.sasversion(full=True)
INFO:root:Running sasversion -v
INFO:root:sasversion (sasversion-1.3) [xmmsas_20190531_1155-18.0.0]


# Show the version of the task 'evselect'
>>>"evselect", "-v")

# Create a Calibration Index File for a given observation
# Raise exception if the task fails
>>> os.environ["SAS_ODF"] = "/path/to/observation/ODF"
>>"cifbuild", calindexset="ccf.cif")

# Create a Calibration Index File for a given observation
# Returns None if the task fails
>>> os.environ["SAS_ODF"] = "/path/to/observation/ODF"
>>>"cifbuild", calindexset="ccf.cif", raise_error=False)

The output messages from the SAS tasks are captured through the python logging system. The messages are included at the logging level defined bt the parameter verbosity_level. For example:

>>“cifbuild”, calindexset=”ccf.cif”, verbosity_level=logging.DEBUG)

will include the output messages of the task as DEBUG messages. By default the logging level is INFO. For not capturing the messages through the logging system, use verbosity_level=0.

If the task runs succesfully, returns the output text as a string. By default, if an error happens during execution, and exception is raised. If the keyword argument raise_error is set to False, then no exception is raised and it just returns None.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pxsas-1.2.tar.gz (4.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page