8000 Proposal for re-ordering the tutorials · Issue #5796 · gammapy/gammapy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Proposal for re-ordering the tutorials #5796

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.

Sign up for GitHub

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

Jump to bottom
Open
facero opened this issue Apr 11, 2025 · 4 comments
Open

Proposal for re-ordering the tutorials #5796

facero opened this issue Apr 11, 2025 · 4 comments
Assignees
@facero
Labels
coding sprint To be tackled during coding sprint docs
Milestone
2.0

Comments

@facero
Copy link
Contributor
facero commented Apr 11, 2025

Following a discussion at the codingsprint, we realize that some basic concepts of the analysis steps could benefit from more attention in the tutorial page.

In order to tackle this issue, we propose to re-order the tutorials in the following way :

Just between the Data analysis and the 1D Spectral create a new section that would be called Key analysis steps .
It would contain a good fraction of the notebooks that are currently in the API section but re-order so to follow the steps of an analysis workflow. Namely :

  • IRFS
  • Observational clustering
  • Data reduction
  • Datasets
  • Maps
  • Mask
  • Catalogs
  • Models
  • Priors
  • Modeling
  • Fitting
  • Bayesian sampling
  • Estimators

This would imply that the dark matter tutorial in the API would be left orphan but it could be added in a new section together with EBL and energy dependent morphology ? (which are advanced astro use case ).

Comments are welcome !
@facero facero added coding sprint To be tackled during coding sprint docs labels Apr 11, 2025
@facero facero added this to the 2.0 milestone Apr 11, 2025
@facero facero self-assigned this Apr 11, 2025
@bkhelifi
Copy link
Member

I like this proposal!
A suggestion maybe: the catalogs API generates models. So, I will invert the two.

@bkhelifi bkhelifi mentioned this issue Apr 11, 2025
Open
36 tasks
@AtreyeeS
Copy link
Member
AtreyeeS commented Apr 11, 2025 •
edited
Loading

Note that the dark matter notebook is repeated in the tutorials and in the recipes. They are identical copies except for the fact that the on in gammapy-recipes lacks the section on flux maps for decay.
We should remove one of them, probably the one in recipes

@Astro-Kirsty
Copy link
Member

We also had a discussion about this today. Maybe we could introduce something like an Examples section in addition to the Tutorials. These types of examples would show very specific things and we quite short. See for instance what they do in sunpy.
I think the question of the tutorials, structure and content is a common thing we discuss, so we should come to an agreement on how to proceed soon.

For now I agree with the suggestion you have given @facero for v2.0!

@facero facero mentioned this issue May 6, 2025
Merged
This was referenced May 12, 2025
Closed
Closed
@facero
Copy link
Contributor Author
facero commented May 21, 2025

I like the idea of the example section.
This could included DM, EBL, and energy dependent morpho for example ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@facero facero

Labels
coding sprint To be tackled during coding sprint docs
Projects
April 2025 - coding sprint
Status: Todo
Documentation
Status: No status
Milestone
2.0
Development

No branches or pull requests
4 participants
@facero @bkhelifi @AtreyeeS @Astro-Kirsty
0