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

Page for users' guide on pedestal estimation tool #159

Merged
merged 3 commits into from
Nov 6, 2024

Conversation

tibaldo
Copy link
Member

@tibaldo tibaldo commented Nov 5, 2024

I wrote a first minimalistic version of a documentation page for the users' guide on the pedestal estimation tool. How does it look? Is there anything that should be added or changed?

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.51%. Comparing base (b306f30) to head (096c243).
Report is 33 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #159      +/-   ##
==========================================
+ Coverage   40.76%   47.51%   +6.74%     
==========================================
  Files          65       64       -1     
  Lines        4452     4590     +138     
==========================================
+ Hits         1815     2181     +366     
+ Misses       2637     2409     -228     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jlenain
Copy link
Collaborator

jlenain commented Nov 6, 2024

Hi @tibaldo!
Thanks a lot for this! The documentation builds nicely locally:
image
(I have to use another theme locally with respect to the ReadTheDocs site to compile the doc properly).

It would be nice if you could (very) briefly describe the different filter methods (WaveformsStdFilter and ChargeDistributionFilter). Do you think it could be feasible?

@tibaldo
Copy link
Member Author

tibaldo commented Nov 6, 2024

Hi @jlenain, thanks for the review. I implemented the addition you suggested. I also added some information about the number of events per slice and the bad pixel flagging.

@tibaldo tibaldo marked this pull request as ready for review November 6, 2024 15:20
@tibaldo tibaldo added the documentation Improvements or additions to documentation label Nov 6, 2024
@jlenain
Copy link
Collaborator

jlenain commented Nov 6, 2024

Thank you very much, @tibaldo !

@jlenain jlenain merged commit b77149f into cta-observatory:main Nov 6, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants