.. pyxsim documentation master file, created by
sphinx-quickstart on Sat Apr 9 10:00:48 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
pyXSIM Documentation
====================
.. raw:: html
What is pyXSIM?
---------------
pyXSIM is a Python package for simulating X-ray emission 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.
License
-------
pyXSIM is released under a
`BSD 3-clause license `_.
Current Version
---------------
The current stable version is 4.4.0. See the :ref:`changelog` for details on
changes from previous versions.
Table of Contents
-----------------
.. toctree::
:maxdepth: 2
installing
v3_to_v4
basic_concepts
source_models/index
xray_fields
spectra
photon_lists/index
parallel
getting_help
cookbook/index
api/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`