What is pyXSIM?¶
pyXSIM is a Python package for simulating X-ray observations from astrophysical sources.
X-rays probe the high-energy universe, from hot galaxy clusters to compact objects such as neutron stars and black holes and many interesting sources in between. pyXSIM makes it possible to generate synthetic X-ray observations of these sources from a wide variety of models, whether from grid-based simulation codes such as FLASH, Enzo, and Athena, to particle-based codes such as Gadget and AREPO, and even from datasets that have been created “by hand”, such as from NumPy arrays. pyXSIM also provides facilities for manipulating the synthetic observations it produces in various ways, as well as ways to export the simulated X-ray events to other software packages to simulate the end products of specific X-ray observatories.
The Heritage of pyXSIM¶
pyXSIM is an implementation of the PHOX algorithm, developed for constructing mock X-ray observations from SPH datasets by Veronica Biffi and Klaus Dolag. There are two relevant papers:
pyXSIM had a previous life as the
photon_simulator analysis module as a part of the
yt Project. pyXSIM still depends critically on yt to provide the
link between the simulation data and the algorithm for generating the X-ray photons. For
detailed information about the design of the algorithm in yt, check out
the SciPy 2014 Proceedings.
The current stable version is 2.3.1. See the ChangeLog for details on changes from previous versions.
Table of Contents¶
- Installing pyXSIM
- Important API Changes Between pyXSIM Version 1 and Version 2
- How pyXSIM Works
- Basic yt Concepts
- Photon Lists
- Source Models for Generating Photons
- Absorption Models
- Event Lists
- Producing Realistic Observations Using External Packages
- Source Generators
- Running in Parallel
- Getting Help
- Frequently Asked Questions
- pyXSIM Cookbook