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).

Dependencies

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 pysas 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"

Installation

pxsas can be easily installed using pip:

pip install pxsas

Example

A simple example of using pxsas:

import os
import pxsas

# Show SAS version used by pxsas
pxsas.sasversion(full=True)

# Show the version of the task 'evselect'
pxsas.run("evselect", "-v")

# Create a Calibration Index File for a given observation
os.environ["SAS_ODF"] = "/path/to/observation/ODF"
pxsas.run("cifbuild", calindexset="ccf.cif")

The output messages from the SAS tasks are captured through the python logging system. If the task runs succesfully, pxsas.run returns the output text as a string. If an error happens during execution, it 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.0.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

pxsas-1.0-py3-none-any.whl (3.9 kB view hashes)

Uploaded Python 3

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