Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove HGPS map and catalog tutorial #2654

Merged
merged 2 commits into from Dec 2, 2019
Merged

Remove HGPS map and catalog tutorial #2654

merged 2 commits into from Dec 2, 2019

Conversation

@cdeil
Copy link
Member

cdeil commented Dec 2, 2019

This PR removes tutorials/hgps.ipynb.

I added it in May 2018 when releasing the HESS Galactic plane survey paper / maps / catalog (see https://www.mpi-hd.mpg.de/hfm/HESS/hgps/), a rendered version of the notebook is here: https://docs.gammapy.org/0.14/notebooks/hgps.html

I think at the time it made sense, I heard from several people that they used this to learn how to work with FITS images and catalogs.

But now, similar to other docs content that we removed like the Sherpa tutorials, I think it's best to remove this as well. Specifically there's a lot of duplication with https://docs.gammapy.org/0.14/notebooks/first_steps.html and that still needs to be cleaned up, and having a second very long notebook tutorials/hgps.ipynb makes us go slow on getting the docs to a good state. Some things can always be added back in the future, like how to plot a survey map or make cutouts.

However, one issue with the notebook is that in https://docs.gammapy.org/0.14/notebooks/hgps.html#Download-Data the significance survey FITS map is downloaded. This slows down our docs build and notebook testing, generally our strategy is to ship all example data via gammapy download, and to avoid web queries otherwise. Yesterday I was on the train, and make docs-all was hanging because I didn't have the bandwidth to download this file, i.e. I couldn't check my docs edits. So that's another reason why we should remove this now, or someone should spend the time to add this significance FITS maps to the example datasets and then we access it via $GAMMAPY_DATA.

@adonath @registerrier - Thoughts?

@cdeil cdeil added cleanup docs labels Dec 2, 2019
@cdeil cdeil added this to the 0.15 milestone Dec 2, 2019
@cdeil cdeil requested review from adonath and registerrier Dec 2, 2019
@cdeil cdeil self-assigned this Dec 2, 2019
@cdeil cdeil added this to In Progress in DOCUMENTATION via automation Dec 2, 2019
Copy link
Contributor

registerrier left a comment

Thanks @cdeil !
We can remove indeed.
Yet there are many interesting things in this notebook. So we should add a lighter version of it back in at some point.

@adonath
adonath approved these changes Dec 2, 2019
Copy link
Member

adonath left a comment

I agree it's the cleaner solution to remove it for now.

@adonath adonath merged commit c8ed48c into gammapy:master Dec 2, 2019
9 of 10 checks passed
9 of 10 checks passed
greeting
Details
continuous-integration/travis-ci/pr The Travis CI build failed
Details
Codacy/PR Quality Review Up to standards. A positive pull request.
Details
Scrutinizer Analysis: No new issues – Tests: passed
Details
gammapy.gammapy #20191202.23 succeeded
Details
gammapy.gammapy (DevDocs) DevDocs succeeded
Details
gammapy.gammapy (Lint) Lint succeeded
Details
gammapy.gammapy (Test Python36) Test Python36 succeeded
Details
gammapy.gammapy (Test Windows36) Test Windows36 succeeded
Details
gammapy.gammapy (Test Windows37) Test Windows37 succeeded
Details
DOCUMENTATION automation moved this from In Progress to Done Dec 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
DOCUMENTATION
  
Done
3 participants
You can’t perform that action at this time.