ImperialCollegeLondon / pyrealm

Development of the pyrealm package, providing an integrated toolbox for modelling plant productivity, growth and demography using Python.
https://pyrealm.readthedocs.io/
MIT License
23 stars 9 forks source link

Building out better structured data package of golden outputs and example data. #108

Closed davidorme closed 1 year ago

davidorme commented 1 year ago

This PR:

There are some things that need fixing - the first should be fixed here, but I think we leave the second for now.

  1. I'm includeing the CONTRIBUTING.md contents in docs/source/development/developers.md verbatim to avoid duplication of what would basically be identical content, but that breaks some links which make sense in the location of CONTRIBUTING.md but not in docs. I can't see a sensible solution apart from duplication or making CONTRIBUTING.md a simple pointer to the ReadTheDocs, which I don't like as much.

  2. The pyrealm_build_data contents description includes requirements and shell commands for running generating some of the benchmark datasets but not all the examples are complete:

    • The subdaily submodule requires the original R code and some settings, but these are in a separate repo.
    • The uk_data submodule was generated from input datasets on fixed paths and those (large) datasets and paths are not replicated here.
    • The requirements to run these commands are not yet part of the package requirements. These are largely R and a couple of reference packages. We can either just document the requirements as here or possible extend pyproject.toml to include an optional group for running these scripts. I lean towards the first solution as these really aren't expected to change frequently, if ever.

This closes #24 and #60.

codecov-commenter commented 1 year ago

Codecov Report

Merging #108 (26cf2d6) into develop (e2a4949) will increase coverage by 0.12%. Report is 16 commits behind head on develop. The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #108      +/-   ##
===========================================
+ Coverage    93.23%   93.36%   +0.12%     
===========================================
  Files           18       18              
  Lines         1109     1160      +51     
===========================================
+ Hits          1034     1083      +49     
- Misses          75       77       +2     

see 1 file with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more