DavidT3 / XGA

X-ray: Generate and Analyse is a module designed to make the analysis of XMM observations simple and efficient. It provides an interface with SAS for the creation of XMM data products, as well as a way to easily perform fits (scalable for multiple observations) and retrieve information about an object, all within a Python package.
BSD 3-Clause "New" or "Revised" License
30 stars 3 forks source link

Update the documentation to reflect support for Chandra #1244

Open DavidT3 opened 2 weeks ago

DavidT3 commented 2 weeks ago

Once Chandra support has been implemented, we'll also need to be able to tell users about it. That means making changes to the documentation (the majority of which is the readthedocs website, but also includes the GitHub README).

As I said, the main changes are to the big documentation website - that will include updating the introduction and installation instructions to make mention of Chandra, and what backend software that requires. Should be pretty simple with Chandra, as we can just say that CIAO is included as a Python dependency.

Such changes should be made to the rst files in the docs directory in the xga repository. This issue does not include altering tutorials to better reflect Chandra support, as that will be a substantial job and will be its own issue.