This fixes problems 1 and 2 outlined in issue #3 and replaces the fixes in merge request !25.
The pull request adds:
The pull request is passing tests and work on the code from issue #3..
Nils Brüggemann (ff3bf26c) at 14 Mar 18:05
Merge branch 'plotting-fixes' into 'master'
... and 1 more commit
Nice! Thank you!
This fixes problems 1 and 2 outlined in issue #3 and replaces the fixes in merge request !25.
The pull request adds:
The pull request is passing tests and work on the code from issue #3..
Nils Brüggemann (33c05928) at 11 Mar 08:35
Merge branch 'fix-croptgrid' into 'master'
... and 8 more commits
The function xr_crop_tgrid_data
was failing tests. The issue has been identified and fixed. This implements the fix from !25.
Looking good! Thank you, Fraser!
Nils Brüggemann (ee6fa573) at 11 Mar 08:31
Merge branch 'api-docs' into 'master'
... and 9 more commits
I believe the problem with autodoc constructing the documentation was caused by missing dependencies. This merge request install all pyicon dependencies before attempting to build the documentation.
Hi Fraser, thank you! I am wondering if we have to live with the 5min but for the moment, I think we should.
I have now added extra tests from !25 and a fix for the nabla function.
The function xr_crop_tgrid_data
was failing tests. The issue has been identified and fixed. This implements the fix from !25.
I've marked this as a draft and will submit several different merge requests for the changes I've made. This will hopefully make the changes more transparent.
This fixes the problem with the documentation not building properly. The documentation is now built by a gitlab runner with conda available. Conda installs any dependencies then makes the documentation. I have verified the documentation builds using the conda runner on my source branch. I presume the documentation will still be automatically published, though I've been unable to test this. The documentation now takes around 5 minutes to build rather than 1 minute due to the dependency installation.
Had a go at building the documentation in an empty environment using docker. This pull request as isn't ready and needs some refinement.
I believe the problem with autodoc constructing the documentation was caused by missing dependencies. This merge request install all pyicon dependencies before attempting to build the documentation.
Nils Brüggemann (4d317162) at 04 Mar 08:50
Merge branch 'api-docs' into 'master'
... and 2 more commits
Updated docs so they should automatically get documentation from the docstrings when available. Would suggest checking line 21 of doc/conf.py as I had to make that change to be able to build the docs on my computer but I don't know how it will effect the hosting on gitlab pages?
This turned into a large pull request so apologies. To summarise the features it adds:
plot
function to give better error messages when grids etc. can't be found. Also added some docstring info. This is the bulk of the merge request and the problems it addresses are detailed in issue #3.pyicon_params.py
to automatically save files elsewhere when not on levante.xr_crop_tgrid
that became apparent when running the tests.xr_calc_curl
that became apparent when running the tests.conftest.py
to include lazy and eagerly loaded datasets. Also updated the tests accordingly.config_ckdtree/config_ckdtree_r2b4_oce_r0004.py
script to save grids to the grid_path
set by the user. This allows the script to run on non-levante systems, which is needed for running the automatic testing.autopep8
on all files changed to make things look nice.At the moment the automatic testing happens in a container on my laptop. If the automatic testing is something we'd like to keep, we can ask DKRZ to provide us with a "runner" to run the tests instead. See https://docs.dkrz.de/doc/software%26services/gitlab-runner.html#dkrz-runners.
The test data at https://swift.dkrz.de/v1/dkrz_07387162e5cd4c81b1376bd7c648bb60/pyicon_example_data/icon_example_data_r2b4.nc is not available. Not sure if this is due to access rights or because it's permanently missing?