Merge branch 'master' into refine/viewSpectraProperly

.github/workflows/joss_paper_draft.yml

@@ -1,3 +1,6 @@
+# This modification is heavily based on GitHub user zonca's version linked
+#  in https://github.com/openjournals/joss/issues/132#issuecomment-890440692
+
 # The overall name of this action
 name: Compile draft XGA JOSS Paper
 
@@ -22,16 +25,34 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-        # Then use the JOSS action to build the paper
-      - name: Build draft PDF
-        uses: openjournals/openjournals-draft-action@master
-        # Sets the specific journal to be built for, and where the Markdown file lives
+      - name: Build TeX and PDF
+        uses: docker://openjournals/paperdraft:latest
         with:
-          journal: joss
-          paper-path: paper/paper.md
+          args: '-k paper/paper.md'
+        # Sets the specific journal to be built for, and where the Markdown file lives
+        env:
+          GIT_SHA: $GITHUB_SHA
+          JOURNAL: joss
       - name: Upload
         uses: actions/upload-artifact@v1
         with:
           name: paper
-          # This is the output path where Pandoc will write the compiled PDF
-          path: paper/paper.pdf
+          path: paper/
+
+#    # Sets up the steps of the job, firstly we check out the master branch
+#    steps:
+#      - name: Checkout
+#        uses: actions/checkout@v2
+#        # Then use the JOSS action to build the paper
+#      - name: Build draft PDF
+#        uses: openjournals/openjournals-draft-action@master
+#        # Sets the specific journal to be built for, and where the Markdown file lives
+#        with:
+#          journal: joss
+#          paper-path: paper/paper.md
+#      - name: Upload
+#        uses: actions/upload-artifact@v1
+#        with:
+#          name: paper
+#          # This is the output path where Pandoc will write the compiled PDF
+#          path: paper/paper.pdf

.github/workflows/publish_to_pypi.yml

@@ -41,14 +41,17 @@ jobs:
         build
         --user
     
+#     - name: Build a binary wheel and source tarball
+#       run: >-
+#         python -m
+#         build
+#         --sdist
+#         --wheel
+#         --outdir dist/
+#         .
     - name: Build a binary wheel and source tarball
       run: >-
-        python -m
-        build
-        --sdist
-        --wheel
-        --outdir dist/
-        .
+        python3 setup.py sdist bdist_wheel
     
     # Then the module is published to the real PyPI index
     - name: Publish to PyPI

.gitignore

@@ -2,4 +2,5 @@
 /docs/source/notebooks/advanced_tutorials/random_brightness_profile.xga
 .coverage
 .pytest_cache
-xga_output
+xga_output
+.ipynb_checkpoints

README.md

@@ -5,7 +5,7 @@
 [![Documentation Status](https://readthedocs.org/projects/xga/badge/?version=latest)](https://xga.readthedocs.io/en/latest/?badge=latest)
 [![Coverage Percentage](https://raw.githubusercontent.com/DavidT3/XGA/master/tests/coverage_badge.svg)](https://raw.githubusercontent.com/DavidT3/XGA/master/tests/coverage_badge.svg)
 
-# What is XMM: Generate and Analyse (XGA)?
+# What is X-ray: Generate and Analyse (XGA)?
 
 XGA is a Python module designed to make it easy to analyse X-ray sources that have been observed by the XMM-Newton Space telescope. It is based around declaring different types of source and sample objects which correspond to real X-ray sources, finding all available data, and then insulating the user from the tedious generation and basic analysis of X-ray data products.
 
@@ -17,6 +17,16 @@ This module also supports more complex analyses for specific object types; the e
 This is a slightly more complex installation than many Python modules, but shouldn't be too difficult. If you're
 having issues feel free to contact me.
 
+## Data Required to use XGA
+### Cleaned Event Lists
+**This is very important** - Currently, to make use of this module, you **must** have access to cleaned XMM-Newton
+event lists, as XGA is not yet capable of producing them itself.
+
+### Region Files
+It will be beneficial if you have region files available, as it will allow XGA to remove interloper sources. If you
+wish to use existing region files, then they must be in a DS9 compatible format, **point sources** must be **red** and
+**extended sources** must be **green**.
+
 ## The Module
 XGA has been uploaded to PyPi, so you can simply run:
 ```shell script
@@ -34,8 +44,7 @@ python setup.py install
 XGA depends on two non-Python pieces of software:
 * XMM's Science Analysis System (SAS) - Version 17.0.0, but other versions should be largely compatible with the
     software. SAS version 14.0.0 however, does not support features that PSF correction of images depends on.
-* HEASoft's XSPEC - Version 12.10.1, **I can't guarantee later versions will work.**
-* HEASoft's XSPEC - Version 12.10.1, **I can't guarantee later versions will work.**
+* HEASoft's XSPEC - Version 12.10.1, but other versions should be largely compatible even if I have not tested them.
 
 All required Python modules can be found in requirements.txt, and should be added to your system during the 
 installation of XGA.
@@ -106,7 +115,7 @@ If you encounter a bug, or would like to make a feature request, please use the
 [issues](https://github.com/DavidT3/XGA/issues) page, it really helps to keep track of everything.
 
 However, if you have further questions, or just want to make doubly sure I notice the issue, feel free to send
-me an email at [email protected]
+me an email at [email protected]