Merge pull request #194 from open-gamma-ray-astro/prepare_0.3

Prepare release 0.3
open-gamma-ray-astro · Nov 4, 2022 · 9eda7b6 · 9eda7b6
2 parents 891b447 + d5652bb
commit 9eda7b6
Show file tree

Hide file tree

Showing 20 changed files with 47 additions and 53 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,19 +19,16 @@ https://lists.nasa.gov/mailman/listinfo/open-gamma-ray-astro .
 
 ## Run Sphinx
 
-We use the Sphinx Readthedocs theme.
-To build the HTML docs locally you first have to install Sphinx.
+We use the Sphinx Readthedocs theme and manage dependencies using poetry.
 
-With pip::
-
-    pip install sphinx sphinx_rtd_theme
+You first need to install `poetry`.
 
-If you use conda::
+With pip::
 
-    conda create -n gadf python=3.6 sphinx sphinx_rtd_theme
-    conda activate gadf
+    pip install poetry
 
 Then to build and view the HTML docs locally::
 
-    make html
-    open build/html/index.html
+    poetry install
+    poetry run make html
+    poetry run python -m http.server -d build/html/index.html
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Data formats for gamma-ray astronomy [![CC-BY 4.0](https://licensebuttons.net/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/) [![Build Status](https://travis-ci.com/open-gamma-ray-astro/gamma-astro-data-formats.svg?branch=master)](https://travis-ci.com/open-gamma-ray-astro/gamma-astro-data-formats) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1409831.svg)](https://doi.org/10.5281/zenodo.1409831)
+# Data formats for gamma-ray astronomy [![CC-BY 4.0](https://licensebuttons.net/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/) [![CI](https://github.com/open-gamma-ray-astro/gamma-astro-data-formats/actions/workflows/ci.yml/badge.svg)](https://github.com/open-gamma-ray-astro/gamma-astro-data-formats/actions/workflows/ci.yml) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1409830.svg)](https://doi.org/10.5281/1409830)
 
 The _Data formats for gamma-ray astronomy_ is a community-driven initiative for the definition of a common and open high-level data format for gamma-ray instruments.
 
@@ -12,14 +12,16 @@ Stable versions of the spec are done via git tags and are shown as releases here
 https://github.com/open-gamma-ray-astro/gamma-astro-data-formats/releases
 
 HTML and PDF versions for stable versions are available via the version selector
-in the lower left on ReadTheDocs. As an example, for version 0.2:
+in the lower left on ReadTheDocs. As an example, for version 0.3:
 
-- HTML at <https://gamma-astro-data-formats.readthedocs.io/en/v0.2/>
-- PDF at <https://media.readthedocs.org/pdf/gamma-astro-data-formats/v0.2/gamma-astro-data-formats.pdf>
+- HTML at <https://gamma-astro-data-formats.readthedocs.io/en/v0.3/>
+- PDF at <https://media.readthedocs.org/pdf/gamma-astro-data-formats/v0.3/gamma-astro-data-formats.pdf>
 
-For v0.2 we also archived the sources of the spec as well as a rendered PDF and HTML version here:
-<https://doi.org/10.5281/zenodo.1409830> 
-To cite that version, you can use the bibtex entry [here](https://zenodo.org/record/1409831/export/hx#.W5EBLNgzY_U).
+
+The archived versions of the standard are available on zenodo:
+- v0.2:
+  - <https://doi.org/10.5281/zenodo.1409831>
+  - [BibTeX citation](https://zenodo.org/record/1409831/export/hx#.W5EBLNgzY_U).
 
 ## Building the documents locally
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gamma-astro-data-formats"
-version = "0.3.0.a0"
+version = "0.3.0"
 description = "Standardized Data Formats for Gamma-Ray Astronomy"
 authors = ["Christoph Deil et al."]
 

diff --git a/source/about.rst b/source/about.rst
@@ -21,8 +21,9 @@ To work towards open and interoperable data formats for gamma-ray astronomy, we
 have started this open data format specification. This was started at the
 `PyGamma15 workshop`_ in November 2015, followed by a `meeting in April 2016 in
 Meudon`_ and another `meeting in March 2017 in Heidelberg`_. Version
-0.1 of the spec was release in April 2016, version 0.2 in August 2018. You can
-find more information about this effort in `Deil et al. (2017)
+0.1 of the spec was release in April 2016, version 0.2 in August 2018,
+version 0.3 in November 2022.
+You can find more information about this effort in `Deil et al. (2017)
 <https://adsabs.harvard.edu/abs/2017AIPC.1792g0006D>`__.
 
 The scope of this effort is to cover all **high-level** data from gamma-ray

diff --git a/source/conf.py b/source/conf.py
@@ -59,9 +59,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.dev'
+version = '0.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.dev'
+release = '0.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/source/data_storage/hdu_index/index.rst b/source/data_storage/hdu_index/index.rst
@@ -57,7 +57,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU (this HDU itself, the HDU index table):
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'INDEX'
 * ``HDUCLAS2`` = 'HDU'

diff --git a/source/data_storage/obs_index/index.rst b/source/data_storage/obs_index/index.rst
@@ -140,7 +140,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'INDEX'
 * ``HDUCLAS2`` = 'OBS'

diff --git a/source/index.rst b/source/index.rst
@@ -1,14 +1,8 @@
 .. _main-page:
 
 
-.. CAUTION::
-    This is a Work-In-Progress draft for the next iteration of the standard.
-    To view the latest released version of the standard,
-    visit https://gamma-astro-data-formats.readthedocs.io/en/v0.2/
-
-
-Data formats for gamma-ray astronomy
-====================================
+Data formats for gamma-ray astronomy |version|
+==============================================
 
 .. image:: https://licensebuttons.net/l/by/4.0/88x31.png
     :target: https://creativecommons.org/licenses/by/4.0/

diff --git a/source/irfs/full_enclosure/aeff/create_example_file.py b/source/irfs/full_enclosure/aeff/create_example_file.py
@@ -26,7 +26,7 @@
 header['LO_THRES'] = 0.1, 'Low energy threshold [TeV]'
 header['HI_THRES'] = 50, 'High energy threshold [TeV]'
 header['HDUDOC'] = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats', ''
-header['HDUVERS'] = '0.2', ''
+header['HDUVERS'] = '0.3', ''
 header['HDUCLASS'] = 'GADF', ''
 header['HDUCLAS1'] = 'RESPONSE', ''
 header['HDUCLAS2'] = 'EFF_AREA', ''

diff --git a/source/irfs/full_enclosure/aeff/index.rst b/source/irfs/full_enclosure/aeff/index.rst
@@ -54,7 +54,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'EFF_AREA'

diff --git a/source/irfs/full_enclosure/bkg/create_bkg_2d_example_file.py b/source/irfs/full_enclosure/bkg/create_bkg_2d_example_file.py
@@ -24,7 +24,7 @@
 header['LO_THRES'] = 0.1 , 'Low energy threshold [TeV]'
 header['HI_THRES'] = 50 , 'High energy threshold [TeV]'
 header['HDUDOC'] = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats', ''
-header['HDUVERS'] = '0.2', ''
+header['HDUVERS'] = '0.3', ''
 header['HDUCLASS'] = 'GADF', ''
 header['HDUCLAS1'] = 'RESPONSE', ''
 header['HDUCLAS2'] = 'BKG', ''

diff --git a/source/irfs/full_enclosure/bkg/create_bkg_3d_example_file.py b/source/irfs/full_enclosure/bkg/create_bkg_3d_example_file.py
@@ -28,7 +28,7 @@
 header['LO_THRES'] = 0.1 , 'Low energy threshold [TeV]'
 header['HI_THRES'] = 50 , 'High energy threshold [TeV]'
 header['HDUDOC'] = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats', ''
-header['HDUVERS'] = '0.2', ''
+header['HDUVERS'] = '0.3', ''
 header['HDUCLASS'] = 'GADF', ''
 header['HDUCLAS1'] = 'RESPONSE', ''
 header['HDUCLAS2'] = 'BKG', ''

diff --git a/source/irfs/full_enclosure/bkg/index.rst b/source/irfs/full_enclosure/bkg/index.rst
@@ -38,7 +38,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'BKG'
@@ -75,7 +75,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'BKG'

diff --git a/source/irfs/full_enclosure/edisp/index.rst b/source/irfs/full_enclosure/edisp/index.rst
@@ -28,15 +28,15 @@ Recommended axis order: ``ENERGY``, ``MIGRA``, ``THETA``
 
 Header keywords:
 
-As explained in :ref:`hduclass`, the following header keyword should be used to 
+As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'EDISP'
 * ``HDUCLAS3`` = 'FULL-ENCLOSURE'
-* ``HDUCLAS4`` = 'EDISP_2D'  
+* ``HDUCLAS4`` = 'EDISP_2D'
 
 Example data file: TODO
diff --git a/source/irfs/full_enclosure/psf/psf_3gauss/index.rst b/source/irfs/full_enclosure/psf/psf_3gauss/index.rst
@@ -63,7 +63,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'PSF'

diff --git a/source/irfs/full_enclosure/psf/psf_gtpsf/index.rst b/source/irfs/full_enclosure/psf/psf_gtpsf/index.rst
@@ -18,15 +18,15 @@ The FITS file has the following BinTable HDUs / columns:
 
 Header keywords:
 
-As explained in :ref:`hduclass`, the following header keyword should be used to 
+As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'PSF'
 * ``HDUCLAS3`` = 'FULL-ENCLOSURE'
-* ``HDUCLAS4`` = 'GTPSF'  
+* ``HDUCLAS4`` = 'GTPSF'
 
 Example data file: :download:`psf-fermi.fits`
diff --git a/source/irfs/full_enclosure/psf/psf_king/index.rst b/source/irfs/full_enclosure/psf/psf_king/index.rst
@@ -36,15 +36,15 @@ Recommended axis order: ``ENERGY``, ``THETA``
 
 Header keywords:
 
-As explained in :ref:`hduclass`, the following header keyword should be used to 
+As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'PSF'
 * ``HDUCLAS3`` = 'FULL-ENCLOSURE'
-* ``HDUCLAS4`` = 'PSF_KING'  
+* ``HDUCLAS4`` = 'PSF_KING'
 
 Example data file: TODO
diff --git a/source/irfs/full_enclosure/psf/psf_table/index.rst b/source/irfs/full_enclosure/psf/psf_table/index.rst
@@ -28,15 +28,15 @@ Recommended axis order: ``ENERGY``, ``THETA``, ``RAD``.
 
 Header keywords:
 
-As explained in :ref:`hduclass`, the following header keyword should be used to 
+As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'PSF'
 * ``HDUCLAS3`` = 'FULL-ENCLOSURE'
-* ``HDUCLAS4`` = 'PSF_TABLE'  
+* ``HDUCLAS4`` = 'PSF_TABLE'
 
 Example data file: TODO
diff --git a/source/irfs/point_like/create_rad_max_2d_example_file.py b/source/irfs/point_like/create_rad_max_2d_example_file.py
@@ -21,7 +21,7 @@
 data = table.as_array()
 header = fits.Header()
 header['HDUDOC'] = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats', ''
-header['HDUVERS'] = '0.2', ''
+header['HDUVERS'] = '0.3', ''
 header['HDUCLASS'] = 'GADF', ''
 header['HDUCLAS1'] = 'RESPONSE', ''
 header['HDUCLAS2'] = 'RAD_MAX', ''

diff --git a/source/irfs/point_like/index.rst b/source/irfs/point_like/index.rst
@@ -65,7 +65,7 @@ As explained in :ref:`hduclass`, the following header keyword should be used to
 declare the type of HDU:
 
 * ``HDUDOC``   = 'https://github.com/open-gamma-ray-astro/gamma-astro-data-formats'
-* ``HDUVERS``  = '0.2'
+* ``HDUVERS``  = '0.3'
 * ``HDUCLASS`` = 'GADF'
 * ``HDUCLAS1`` = 'RESPONSE'
 * ``HDUCLAS2`` = 'RAD_MAX'