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

Lack of documentation about AnalysisConfig option identifiers #5181

Open
HealthyPear opened this issue Mar 25, 2024 · 0 comments
Open

Lack of documentation about AnalysisConfig option identifiers #5181

HealthyPear opened this issue Mar 25, 2024 · 0 comments

Comments

@HealthyPear
Copy link
Contributor

I was following the tutorial here
https://docs.gammapy.org/1.2/tutorials/starting/analysis_1.html

and I had to go into the source code to know e.g. which are the allowed string identifiers for the
background subsection.

For example in this case, going backwards from the class I was using, I traced back the answer to my doubt:

AnalysisConfig --> BackgroundConfig --> BackgroundMethodEnum

which allowed me to understand the possible choices are reflected, fov_background or ring.

Apologies if I have overlooked a clearer source of information, but if I am right, then at least the API reference should be updated with more classes (to start, all those used by AnalysisConfig in order to make clear which are all the supported options to use when filling an analysis configuration file).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant