Closed davidorme closed 1 year ago
Merging #108 (26cf2d6) into develop (e2a4949) will increase coverage by
0.12%
. Report is 16 commits behind head on develop. The diff coverage isn/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
This PR:
tests
folder by moving data files and code that generate golden outputs from original implementations into thepyrealm_build_data
package.pyrealm_build_data
into submodules to organise those files.importlib.resources.files("pyrealm_build_data.submodule", "data_file.xyz
)to reference those files in testing and in the
sphinx` docs.pyrealm_build_data
package contents.docs
to mirrorCONTRIBUTING.md
.There are some things that need fixing - the first should be fixed here, but I think we leave the second for now.
I'm
include
ing theCONTRIBUTING.md
contents indocs/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 ofCONTRIBUTING.md
but not indocs
. I can't see a sensible solution apart from duplication or makingCONTRIBUTING.md
a simple pointer to the ReadTheDocs, which I don't like as much.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:subdaily
submodule requires the original R code and some settings, but these are in a separate repo.uk_data
submodule was generated from input datasets on fixed paths and those (large) datasets and paths are not replicated here.R
and a couple of reference packages. We can either just document the requirements as here or possible extendpyproject.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.