This is the repository for the Gammapy v1.0 paper. The goal is to produce a paper that accompanies the v1.0 release of Gammapy. It will describe the package design, features and applications.
The paper will be submitted to Astronomy and Astrophysics. We could consider jointly submitting to the Journal of Open Source Software as well.
We invite you to become a co-author if you either have contributed to the Gammapy core package or have an official role in the Gammapy project.
To get started with paper writing, make a fork of the repository and clone the forked repository to your local machine:
git clone https://github.com/yourgithub/gammapy-v1.0-paper.git
Now enter the local folder of the repository, create the corresponding conda
environment and activate it:
conda env create -f environment.yml
conda activate gammapy-v1.0-paper
To actually build the paper and paper figures locally just use:
make
To clean up failed executions you can use:
make clean
To regenerate the PDF after editing a .tex file just use:
rm ms.pdf
make
You can use the editor of your choice to modify the files in src/text/*.tex.
If you need to add a figure, please either put the corresponding matplotlib/ python
script in src/figures or put a pre-generated image in src/static. However
for reproducibility it is encouraged to submit the python script. The latex figure
will be linked by the label provided in the figure environment see
showyourwork default figure generation
for details.
When writing text please makes use of the shortcuts defined in 0-shortcuts.tex.
To ensure a consistent formatting of the .tex files and check for missing labels,
typos etc. the repository defines pre-commit hooks. Right now the setting is very
strict such that commit is prevented if any pre-commit hook fails. If you find
any un-reosonable behaviour of the hooks please report.