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

Update documentation + general maintenance #62

Merged
merged 91 commits into from Feb 22, 2021

Conversation

HealthyPear
Copy link
Member

@HealthyPear HealthyPear commented Sep 4, 2020

Summary description

  • simplified README (all info are stored in the docs) with updates from current auxiliary services
  • added support for backup documentation on readthedocs (still no automatic notebook execution, though)
  • added many more benchmarks
  • updated all benchmarking results to the latest reference analysis

Requirements

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

Review Jupyter notebook visual diffs & provide feedback on notebooks.


Powered by ReviewNB

@HealthyPear HealthyPear changed the title Update readme Update README Sep 4, 2020
@codecov
Copy link

codecov bot commented Sep 4, 2020

Codecov Report

Merging #62 (8a1bd70) into master (fa3d622) will increase coverage by 0.21%.
The diff coverage is 70.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #62      +/-   ##
==========================================
+ Coverage   36.81%   37.03%   +0.21%     
==========================================
  Files          18       19       +1     
  Lines        1798     1801       +3     
==========================================
+ Hits          662      667       +5     
+ Misses       1136     1134       -2     
Impacted Files Coverage Δ
protopipe/perf/utils.py 24.52% <ø> (ø)
protopipe/scripts/__init__.py 100.00% <ø> (ø)
protopipe/scripts/data_training.py 85.56% <33.33%> (ø)
protopipe/perf/temp.py 23.52% <50.00%> (-2.95%) ⬇️
protopipe/perf/__init__.py 100.00% <100.00%> (ø)
protopipe/pipeline/event_preparer.py 69.34% <100.00%> (+0.90%) ⬆️
protopipe/pipeline/temp.py 81.15% <100.00%> (ø)
protopipe/pipeline/utils.py 50.64% <100.00%> (+0.31%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa3d622...6078440. Read the comment docs.

@HealthyPear HealthyPear changed the title Update README Update README and support documentation on read the docs Sep 9, 2020
@HealthyPear HealthyPear marked this pull request as draft September 9, 2020 13:00
@HealthyPear HealthyPear added documentation Documentation or services hosting it maintenance labels Sep 9, 2020
@HealthyPear HealthyPear added this to In progress in Maintenance Oct 22, 2020
@HealthyPear HealthyPear added this to the Release 0.3 milestone Oct 23, 2020
@HealthyPear HealthyPear mentioned this pull request Dec 1, 2020
4 tasks
@HealthyPear HealthyPear marked this pull request as ready for review February 16, 2021 17:20
@@ -2,7 +2,7 @@
"cells": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we might want to look into later why this is different (not sure anyone has ever really tested the shower-max reco), but since the reconstructed event selection is also different, it's not too bad.


Reply via ReviewNB

Copy link
Contributor

@kosack kosack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some minor changes in the notebooks. Otherwise looks nice.

Maintenance automation moved this from In progress to Review in progress Feb 17, 2021
kosack
kosack previously approved these changes Feb 19, 2021
Copy link
Contributor

@kosack kosack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can re-approve when you make the necessary doc updates

Maintenance automation moved this from Review in progress to Reviewer approved Feb 19, 2021
Maintenance automation moved this from Reviewer approved to Review in progress Feb 19, 2021
Maintenance automation moved this from Review in progress to Reviewer approved Feb 22, 2021
@HealthyPear HealthyPear merged commit 5495547 into cta-observatory:master Feb 22, 2021
Maintenance automation moved this from Reviewer approved to Done Feb 22, 2021
@HealthyPear HealthyPear deleted the update-README branch February 22, 2021 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation or services hosting it maintenance
Projects
Maintenance
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants