This repository contains instruction documents, example scripts, and example Jupyter Notebooks associated with XMM-Newton's pySAS. You can clone this repository onto your local machine by using the command,
git clone https://github.com/XMMGOF/pysas_docs.git
To use these Jupyter Notebooks you will need to install HEASoft, SAS, and pySAS. See the README for pySAS for further instructions.
If you would like to contribute a notebook please contact us! Either through the XMM Newton GOF Helpdesk or by emailing Ryan Tanner directly (ryan.tanner@nasa.gov). If you would like to showcase your science please let us know. We can work with you to turn your science results into an excellent tutorial.
Each tutorial has a level of difficulty:
BeginnerIntermediateAdvanced
The Obs ID used for the tutorial will also be noted.
◈ Basics of pySAS (Beginner - Obs ID: N/A): Explanation of the basics of pySAS.
◈ pySAS Introduction -- Short Version (Beginner - Obs ID: 0802710101): A short introduction to pySAS.
◈ pySAS Introduction -- Long Version (Beginner - Obs ID: 0802710101): A long introduction to pySAS.
◈ The Absolute Beginner's Guide to XMM-Newton (pdf) (Beginner - Obs ID: N/A): The Absolute Beginner's Guide to XMM-Newton.
◈ Switiching from pySAS v1.4 to v2.0 (Beginner - Obs ID: N/A): Differences between pySAS v1.4 and v2.0.
◈ First Time using pySAS on Fornax (Beginner - Obs ID: N/A): Notebook to help set pySAS user defaults on Fornax.
◈ ABC Guide for XMM-Newton -- EPIC Image Creation and Basic Filtering (Beginner - Obs ID: 0123700101): XMM-Newton ABC Guide, EPIC Image Creation and Basic Filtering.
◈ ABC Guide for XMM-Newton -- EPIC Source Extraction and Spectrum Creation (Beginner - Obs ID: 0123700101): XMM-Newton ABC Guide, EPIC Source Extraction and Spectrum Creation.
◈ ABC Guide for XMM-Newton -- Fitting an EPIC Spectrum in XSPEC (Beginner - Obs ID: 0123700101): XMM-Newton ABC Guide, Fitting an EPIC Spectrum in XSPEC.
◈ ABC Guide for XMM-Newton -- Timing Mode Data Processing (Beginner - Obs ID: 0400550201): XMM-Newton ABC Guide, Timing Mode Data Processing.
◈ ABC Guide for XMM-Newton -- RGS Data Processing (Beginner - Obs ID: 0153950701): XMM-Newton ABC Guide, RGS Data Processing.
◈ ABC Guide for XMM-Newton -- Optical Monitor (OM) (Beginner - Obs ID: 0123700101, 0411081601, 0125320801): XMM-Newton ABC Guide, Introduction to Optical Monitor Data.
◈ ABC Guide (PPS) for XMM-Newton -- EPIC Image Creation and Basic Filtering - Using PPS Files (Beginner - Obs ID: 0123700101): XMM-Newton ABC Guide, EPIC Image Creation and Basic Filtering, using PPS Files.
◈ ABC Guide (PPS) for XMM-Newton -- EPIC Source Extraction and Spectrum Creation - Using PPS Files (Beginner - Obs ID: 0123700101): XMM-Newton ABC Guide, EPIC Source Extraction and Spectrum Creation, using PPS Files.
◈ ABC Guide (PPS) for XMM-Newton -- Timing Mode Data Processing - Using PPS Files (Beginner - Obs ID: 0123700101): XMM-Newton ABC Guide, EPIC Source Extraction and Spectrum Creation, using PPS Files.
◈ Generating EPIC Event Lists (Beginner - Obs ID: 0104860501): A guide for processing data from all EPIC cameras on XMM.
◈ Combining the Spectra of the 3 EPIC Cameras -- Part 1: Filtering the Observation (Intermediate - Obs ID: 0111240101): Step-by-step guide to combine the spectra of all three EPIC camera exposures into one single spectrum with corresponding rmf, arf and bkg files.
◈ Combining the Spectra of the 3 EPIC Cameras -- Part 2: Applying XSPEC Models to the Spectra (Intermediate - Obs ID: 0111240101): Applying various XSPEC models to the spectra using pyXSPEC and evaluating the fitness of the models.
◈ Combining the Spectra of the 3 EPIC Cameras -- Part 2 (Short Version): Applying XSPEC Models to the Spectra (Intermediate - Obs ID: 0111240101): Applying various XSPEC models to the spectra using pyXSPEC and evaluating the fitness of the models. (Short Version)
◈ Dealing with Pile-up in an EPIC Source (Intermediate - Obs ID: 0112880701): Introduction on how to deal with pile-up from a bright source.
◈ Dealing with EPIC Out-of-Time Events -- Part 1: Images (Intermediate - Obs ID: 0111240101): This thread will allow the user to create an image cleaned from out-of-time events.
◈ Dealing with EPIC Out-of-Time Events -- Part 2: Spectra (Intermediate - Obs ID: 0111240101): This thread will allow the user to create a spectrum cleaned from out-of-time events.
◈ Source Detection with edetect_chain -- Part 1 (Intermediate - Obs ID: 0123700101): Using edetect_chain to automatically detect sources.
◈ Source Detection with edetect_chain -- Part 2 (Intermediate - Obs ID: 0123700101): Using edetect_chain to simultaneously detect sources in all three EPIC cameras.
◈ EPIC Source Finding Thread: Step-by-Step (Advanced - Obs ID: 0123700101): A step-by-step recipe to run the source detection chain (edetect_chain) in SAS.
◈ How to Use EPIC Instrumental Background Files -- Part 1: Images (Intermediate - Obs ID: 0555630101): The tutorial shows how to produce a Filter Wheel Closed image, and illustrates how it can be used to correct the science data for instrumental background.
◈ How to Use EPIC Instrumental Background Files -- Part 2: Spectra (Coming soon!) (Intermediate - Obs ID: 0693741001): The tutorial shows how to produce a Filter Wheel Closed spectrum, and illustrates how it can be used to correct the science data for instrumental background.
◈ RGS+EPIC Joint Spectral Fitting Part 1: Data Processing (Advanced - Obs ID: 0601390201): XMM-Newton - RGS+EPIC Joint Spectral Fitting.
◈ RGS+EPIC Joint Spectral Fitting Part 2: Fitting the Spectra (Advanced - Obs ID: 0601390201): XMM-Newton - RGS+EPIC Joint Spectral Fitting.
◈ Imaging a Flare from Sagittarius A* (Intermediate - Obs ID: 0112972101): Creating images of a flare from Sagittarius A*. Based on Goldwurm et al. (2003) (DOI 10.1086/345749).
◈ Comparing Changes in Tycho's Supernova Remnant Across Time (Advanced - Obs ID: Multiple): Tutorial on comparing changes in Tycho's Supernova Remnant over many years.
◈ Using PyVO to Find Observations for Analysis (Beginner - Obs ID: Multiple): A tutorial on using PyVO to find Obs IDs for Analysis.
◈ Merging Event Lists From Multiple Obs IDs (Intermediate - Obs ID: Multiple): Merging event lists from multiple Obs IDs to create a mosaiced image.
◈ XMM-Newton Event List Structure (Intermediate - Obs ID: 0079570201): A basic guide to the internal structure of an XMM-Newton event list.
◈ pySAS Helper Functions (Intermediate - Obs ID: N/A): This contains a collection of functions used in pySAS tutorials.
◈ Introduction to Pipeline Processing System (PPS) Files (Intermediate - Obs ID: 0653860101): This tutorial explains the basics of Pipeline Processing System (PPS) files for XMM-Newton.