https://github.com/cosimonigro/gamma-astro-data-formats

Data formats for gamma-ray astronomy

https://github.com/cosimonigro/gamma-astro-data-formats

Repository

Data formats for gamma-ray astronomy

https://github.com/cosimoNigro/gamma-astro-data-formats/blob/master/

# 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)

A place to propose and share data format descriptions for gamma-ray astronomy.

* Repository: https://github.com/open-gamma-ray-astro/gamma-astro-data-formats
* Docs: https://gamma-astro-data-formats.readthedocs.io/
* Mailing list: https://lists.nasa.gov/mailman/listinfo/open-gamma-ray-astro

## Stable versions

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:

- HTML at 
- PDF at 

For v0.2 we also archived the sources of the spec as well as a rendered PDF and HTML version here:
 
To cite that version, you can use the bibtex entry [here](https://zenodo.org/record/1409831/export/hx#.W5EBLNgzY_U).

## Building the documents locally

To build this document locally, clone this repository and install `poetry`,
the tool used for dependency management:
```bash
$ python3 -m pip install [--user] poetry
```
Use `--user` if you are using a system python installation, leave it out if
you are in a virtual environment or conda environment already.

Install the dependencies for building this document:
```
$ poetry install
```

Make the html:
```
$ poetry run make html SPHINXOPTS="-W --keep-going -n --color -j auto"
```

The options are enabling more warnings to make sure everything builds correctly
and run the build on multiple cores.

Start the python http server to get a preview in your browser:
```
$ python3 -m http.server -d build/html
```

You then should be able to browse  and see the document.

Owner

GitHub Events