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

DOC: Add notebooks #300

Merged
merged 15 commits into from
Jan 22, 2024
Merged

DOC: Add notebooks #300

merged 15 commits into from
Jan 22, 2024

Conversation

bzah
Copy link
Member

@bzah bzah commented Jan 19, 2024

Pull Request to resolve #277, #298

  • Unit tests cover the changes.
  • These changes were tested on real data.
  • The relevant documentation has been added or updated.
  • A short description of the changes has been added to doc/source/references/release_notes.rst.

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:

  • some cleanup remains, I'm not sure why the pre-commit hooks (in particular ruff) are not applied to the notebooks right now.
  • we should include a #Get data section in each notebook in case someone wants to execute them locally. That would describe briefly how to use C4I, how to get the metalink file and how to download dataset from this metalink.
  • Add reference to the notebooks in the readme

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

github-actions bot commented Jan 19, 2024

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 💤 0 ❌ 0 🔥 1m 40s ⏱️

@bzah
Copy link
Member Author

bzah commented Jan 19, 2024

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

@bzah bzah merged commit 02cc7cd into master Jan 22, 2024
5 checks passed
@bzah bzah deleted the doc/improve-index-doc branch January 22, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Example of thresholds functionality?
1 participant