https://github.com/ruizca/pxsas

Python 3 wrapper for the XMM-Newton Science Analysis System
https://github.com/ruizca/pxsas

astronomy

Last synced: about 1 month ago
JSON representation

Python 3 wrapper for the XMM-Newton Science Analysis System

• Host: GitHub
• URL: https://github.com/ruizca/pxsas
• Owner: ruizca
• License: bsd-3-clause-clear
• Created: 2020-10-22T09:12:18.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-24T19:32:20.000Z (about 2 years ago)
• Last Synced: 2024-04-25T04:02:42.916Z (8 months ago)
• Topics: astronomy
• Language: Python
• Homepage:
• Size: 11.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
pxsas

=====

.. inclusion-marker-main-readme

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

Installation

------------

``pxsas`` can be easily installed using ``pip``::

    pip install pxsas

Example

-------

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]

    '18.0.0'

    # Show the version of the task 'evselect'

    >>> pxsas.run("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"

    >> pxsas.run("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"

    >>> pxsas.run("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:

    >> pxsas.run("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, ``pxsas.run`` 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``.

.. _SAS: https://www.cosmos.esa.int/web/xmm-newton/what-is-sas

.. _installation: https://www.cosmos.esa.int/web/xmm-newton/sas-installation