Repository files navigation

Master

|Coverage Status Master|

The analysis of X-ray spectra often depends on the correctusage of instrument response files. However, these calculationsare exclusively implemented in one of the three X-ray packages,all of which come with a lot of overhead.

Here, we attempt to separate out and simplify the response calculation insherpa for ease of use with any other (user-written) code.

Clàrsach currently lives exclusively on GitHub (we might upload it topip once it's a little better developed).

Please note: Clàrsach comes with a suite of tests and test data sets thatchecks whether the code words for a range of different X-ray telescopes. Westrongly urge you to download the test data and run those tests! We provideinstructions for both with and without the test data.

Because the test data files are large, we do not keep them in the repository, butin a system called the Git Large File System (git lfs).This is an extension for git maintained by GitHub, and can be downloaded on thegit lfs website or your favourite package manager.

In order to download the repository with the test data, you then move to the directorywhere you wish the code to live and type::

git lfs clone git@github.com:dhuppenkothen/clarsach.gitgit lfs pull origin master

Then move into theclarsach directory. You can install the package by running:

python setup.py install

Depending on your python installation and set up, this may require administrator privileges.Finally, run the tests usingpy.test (you may need to install that, too)::

py.test

Hopefully, this should run without throwing errors. If it does, please contact us throughtheissues.

You can use standard git for cloning the repository, but be aware that the test datawill not be downloaded.

In order to download the repository, do the following::

git clone git@github.com:dhuppenkothen/clarsach.git

In order to install it, you move into theclarsach directory this willcreate and do the following::

python setup.py install

This should install Clàrsach on your system. Please note that your permissionsmight require you to usesudo in order to install the package.

All content copyright © 2017 the authors. The code is distributed under a GPL licence.

Pull requests are welcome! If you are interested in the further development ofthis project, if you find bugs, or have suggestions or comments, please feel free to contact us throughtheissues.

Example data for testing the functionality of Clarsach can be obtained via the following public link:https://uwmadison.box.com/s/im9ke8cdjta8nc2npgvg70zz917kvvfi

Uploaded bylia@astro.wisc.edu