Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Angel Ruiz committed Jun 15, 2024
1 parent 53f28b2 commit a55d061
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
of ECFs for different astronomical X-ray missions. Currently
we include XMM-Newton/EPIC, Swift/XRT and eROSITA. ECFs where
calculated consistently for the different missions using the most
updated calibration files at the date of the package release of t
version of the package.
updated calibration files at the date of the package release.

X-ray sources detected through photon counter cameras are characterized
by count-rates at a given energy band. These count-rates (CR) can be
converted into physical fluxes using the calibrated response of the
detector and assuming an specific spectral model via:

FLUX = CR / ECF

```math
FLUX = CR / ECF
```
where the ECF (Energy Conversion Factor) encapsulate the information
about the response and spectral model for the given energy band.
For an in-depth explanation of ECF and how they are calculated see
Expand All @@ -22,11 +22,23 @@ or the [eROSITA ECF tutorial](https://erosita.mpe.mpg.de/dr1/eSASS4DR1/eSASS4DR1

Details about our ECF calculations for the different missions can
be found in the [corresponding Jupyter notebooks](https://github.com/ruizca/ecfxa/tree/main/calc) included
in this repository.
in the `ecfxa` GitHub repository.


Installation
------------

> pip install ecfxa


Examples
--------

>>> import ecfxa
>>> ero_ecfs = ecfxa.eROSITA(eband="SOFT")
>>> ero_ecfs(nh=3e20, gamma=2.0)
<Quantity 1.18592291e+12 cm2 / erg>

We provide a [Jupyter notebook with examples](https://github.com/ruizca/ecfxa/tree/main/docs/examples.ipynb)
on how to use `ecfxa` for different X-ray missions. Check the full
documentation [here](https://ruizca.github.io/ecfxa/ecfxa/ecfs.html).

0 comments on commit a55d061

Please sign in to comment.