Improve documentation

[sfinkens]

Improve documentation:

• Update installation instructions
• Add usage examples
• Move algorithm descriptions to a new "Methods" chapter
• Move HDF description to a new "Legacy Output" chapter
• Add more readers and an inheritance diagram to API chapter

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]

Codecov Report

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

@@            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%)	⬇️
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%)	⬆️

---

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.

[mraspaud]

Thanks a lot for taking care of the documentation! Some small comments

[ninahakansson]

LGTM

[carloshorn]

Thanks for taking care of documentation.

[carloshorn]

Nice, you started using pre-commit.

[carloshorn]

I am a bit confused by the implementation of this factor, because it is introduced in https://github.com/pytroll/pygac/blob/main/pygac/reader.py#L510 and passed to the solar calibration, but there it raises a deprecation warning according to https://github.com/pytroll/pygac/blob/main/pygac/calibration.py#L334-L340.

[sfinkens]

Found this one: #58 (comment) Looks like a future reminder

[sfinkens]

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

[abhaydd]

Excellent documentation, @sfinkens
I have gone through it and I have no comments.
Thanks a lot!

[sfinkens]

Thanks for taking the time @abhaydd!