pytroll / pygac

A python package to read and calibrate NOAA and Metop AVHRR GAC and LAC data
https://pygac.readthedocs.org/
GNU General Public License v3.0
20 stars 25 forks source link

Improve documentation #99

Closed sfinkens closed 2 years ago

sfinkens commented 2 years ago

Improve documentation:

You can preview the updated version here: https://sfinkens.github.io/

Along the way I also included dependencies for development in setup.py and fixed a minor bug in Reader.get_calibrated_channels (using timestamps before they are computed).

Closes #85, closes #43.

codecov[bot] commented 2 years ago

Codecov Report

Merging #99 (c789da4) into main (95cf613) will increase coverage by 2.76%. The diff coverage is 91.22%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #99      +/-   ##
==========================================
+ Coverage   70.26%   73.02%   +2.76%     
==========================================
  Files          33       33              
  Lines        2795     2829      +34     
==========================================
+ Hits         1964     2066     +102     
+ Misses        831      763      -68     
Impacted Files Coverage Δ
pygac/klm_reader.py 59.39% <ø> (ø)
pygac/pod_reader.py 63.86% <ø> (ø)
pygac/tests/test_reader.py 98.27% <89.79%> (-1.39%) :arrow_down:
pygac/gac_klm.py 83.33% <100.00%> (ø)
pygac/gac_pod.py 83.33% <100.00%> (ø)
pygac/lac_pod.py 61.11% <100.00%> (ø)
pygac/reader.py 79.64% <100.00%> (+14.81%) :arrow_up:

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 95cf613...c789da4. Read the comment docs.

sfinkens commented 2 years ago

Thanks for your review @carloshorn ! Very good to double check that the docs match the current implementation!

sfinkens commented 2 years ago

Thanks for taking the time @abhaydd!