https://github.com/johannesbuchner/xars

X-ray absorption re-emission scattering - Monte Carlo simulator for X-ray obscurers
https://github.com/johannesbuchner/xars

modelling monte-carlo x-ray-spectroscopy xray-spectroscopy

Last synced: 3 months ago
JSON representation

X-ray absorption re-emission scattering - Monte Carlo simulator for X-ray obscurers

• Host: GitHub
• URL: https://github.com/johannesbuchner/xars
• Owner: JohannesBuchner
• License: agpl-3.0
• Created: 2017-07-07T00:02:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-05-13T09:08:45.000Z (5 months ago)
• Last Synced: 2025-07-16T09:48:13.750Z (3 months ago)
• Topics: modelling, monte-carlo, x-ray-spectroscopy, xray-spectroscopy
• Language: Fortran
• Homepage: https://github.com/JohannesBuchner/xars/blob/master/README.rst
• Size: 5.89 MB
• Stars: 17
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
====================================

XARS X-ray Monte-carlo simulator

====================================

.. image:: doc/logo3-large.png

XARS simulates X-rays propagating through matter in user-defined geometries.

Features

---------

XARS is ~400 lines of pure Python code.

* Physical processes:

  * Photo-electric absorption

  * Compton scattering 

  * Fluorescent line emission (self-consistent with absorption above)

* Geometries:

  * Arbitrary user-defined geometries (included examples: toroid, sphere, disk)

  * Arbitrary geometries made from many spherical blobs/clumps (when combined with LightRayRider)

  * Arbitrary grid geometries from hydrodynamic simulations (when combined with LightRayRider)

New contributions are welcome.

How to cite XARS correctly

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

Please reference `Buchner et al (2019) `_. 

Models

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

Go to the `Models `_ page.

In Buchner et al. (in prep) we irradiated the following geometries,

and you can download xspec table models here.

* Sphere, Sphere with Bi-conical cut-out

* Clumpy model made from 100,000 spheres: Unified X-ray Clumpy model UXCLUMPY, CAT3D-WIND

* Radiative fountain, from a hydrodynamic grid simulation

* Warped Disk

* ... and many others 

Downloads, movies and more details on the `Models `_ page.

Installation

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

.. image:: https://img.shields.io/badge/docs-published-ok.svg

        :target: https://johannesbuchner.github.io/xars/

        :alt: Documentation Status

.. image:: https://github.com/JohannesBuchner/xars/actions/workflows/tests.yml/badge.svg

	:target: https://github.com/JohannesBuchner/xars/actions

.. image:: https://coveralls.io/repos/github/JohannesBuchner/xars/badge.svg?branch=master

	:target: https://coveralls.io/github/JohannesBuchner/xars?branch=master

XARS requires the following python modules:

   numpy scipy matplotlib h5py astropy progressbar2

You can install them with pip or conda as usual.

Once these are installed, you just run the scripts from this directory.

Usage

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

See the `Code Tutorial `_ to understand the code.

Questions and Problems

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

If you have any questions or issues or questions, please check the `FAQ `_ or open a `Github issue `_. This helps other people google the same question.

License

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

Free and Open Source software under AGPLv3. 

Contact me if you need a different license.