cerfacs-globc / icclim

icclim: Python library for climate indices and climate indicators calculation.
https://icclim.readthedocs.io/en/latest/
Apache License 2.0
80 stars 32 forks source link

DOC: Add notebooks #300

Closed bzah closed 7 months ago

bzah commented 7 months ago

Pull Request to resolve #277, #298

Describe the changes you made

This PR adds a few notebooks that were initially written by Christian for ISENES to our documentation. This is also a test to make sure the review of jupyter notebooks in PRs is properly enabled via NBReview.

TODO:

review-notebook-app[bot] commented 7 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

github-actions[bot] commented 7 months ago

Coverage

Report
FileStmtsMissCoverMissing
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/icclim
   _generated_api.py184995%17–27
   icclim_logger.py852966%24, 43, 65, 70–95, 105, 111–142, 150–155
   icclim_types.py13130%1–21
   main.py2833488%59–65, 125, 134, 415–419, 502, 528–529, 531–532, 534, 536–537, 539–540, 560–567, 637–642, 727, 734, 738–739
   utils.py40880%14–15, 25–30, 37–41, 43–44
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/icclim/ecad
   xclim_binding.py52885%16–18, 45, 49, 78, 82, 111, 115
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/icclim/generic_indices
   generic_indicators.py4989880%49–55, 68, 72, 89, 93, 97, 110–113, 117, 191, 333–337, 339–343, 389, 420–421, 723–724, 759, 765, 773–774, 794, 958–962, 964–965, 983–989, 993, 1021, 1023, 1091–1092, 1125–1151, 1179–1199, 1215, 1224–1225, 1252–1284, 1290–1293, 1315
   standard_variable.py48198%19
   threshold.py4113492%49–54, 210–211, 233, 237, 285, 301–303, 318–322, 326–330, 410, 552–553, 616–621, 716–717, 912, 935–936, 941, 1015–1016, 1019–1023, 1111–1113
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/icclim/models
   cf_calendar.py35197%20
   climate_variable.py1062180%27–34, 107–113, 168–169, 178, 214–218, 221, 261, 265–269, 296–297, 334
   frequency.py1801592%36–38, 174–177, 321–327, 331, 414–418, 440, 445
   global_metadata.py660%1–9
   index_config.py27581%7–11
   index_group.py38295%33–37
   logical_link.py21195%12
   operator.py31390%10, 15–19
   standard_index.py30680%7–10, 59, 62, 66
   user_index_dict.py20200%1–28
/opt/hostedtoolcache/Python/3.9.18/x64/lib/python3.9/site-packages/icclim/pre_processing
   in_file_dictionary.py880%1–29
   input_parsing.py2055374%22–28, 81–82, 86–87, 92–97, 111–112, 178, 183–187, 190, 200–201, 212–216, 242, 256, 270, 291–296, 300, 302, 310–315, 320–325, 336–337, 351–358, 369–389, 428
   rechunk.py89693%21–22, 43–44, 48, 137
TOTAL265538186% 

Test results

Tests Skipped Failures Errors Time
192 0 :zzz: 0 :x: 0 :fire: 1m 40s :stopwatch:
bzah commented 7 months ago

@pagecp it looks like ReviewNB is working, if you wish you can review (and comment!) on the notebooks that were added.