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

code snippets in docs #1086

Merged
merged 2 commits into from
May 5, 2023
Merged

code snippets in docs #1086

merged 2 commits into from
May 5, 2023

Conversation

vuillaut
Copy link
Member

@vuillaut vuillaut commented Apr 28, 2023

Add a code snippets section in the docs.

@codecov
Copy link

codecov bot commented Apr 28, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (972d908) 71.76% compared to head (de7782e) 71.76%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1086   +/-   ##
=======================================
  Coverage   71.76%   71.76%           
=======================================
  Files         120      120           
  Lines       11348    11348           
=======================================
  Hits         8144     8144           
  Misses       3204     3204           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@vuillaut vuillaut changed the title move snippets code snippets in docs Apr 28, 2023
@vuillaut vuillaut requested a review from morcuended May 4, 2023 09:49
@morcuended
Copy link
Member

Looks good to me. I would also add the way of accessing the configuration used to produce a given file:

with tables.open_file(filename) as file:
    config = yaml.safe_load(file.root.dl1.event.telescope.parameters.LST_LSTCam.attrs["config"])
print(config)

and maybe also which DRS4 baseline correction and calibration coefficients files were used since they are also stored as metadata in the file.

@vuillaut
Copy link
Member Author

vuillaut commented May 5, 2023

Looks good to me. I would also add the way of accessing the configuration used to produce a given file:

with tables.open_file(filename) as file:
    config = yaml.safe_load(file.root.dl1.event.telescope.parameters.LST_LSTCam.attrs["config"])
print(config)

and maybe also which DRS4 baseline correction and calibration coefficients files were used since they are also stored as metadata in the file.

If I merge, could you add this info in another please?

@morcuended
Copy link
Member

morcuended commented May 5, 2023 via email

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

Successfully merging this pull request may close these issues.

3 participants