Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6868 +/- ##
=======================================
Coverage 90.11% 90.11%
=======================================
Files 91 91
Lines 24912 24912
Branches 4675 4675
=======================================
Hits 22449 22449
Misses 1684 1684
Partials 779 779 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
⏱️ Performance Benchmark Report: 81d3d5cPerformance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 66292e1Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 1dd2193Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 80c46abPerformance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 782a5d8Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 39ca485Performance shiftsFull benchmark resultsGenerated by GHA run |
There was a problem hiding this comment.
Templating
This PR includes changes that may be worth sharing via templating. For each file listed below, please either:
- Action the suggestion via a pull request editing/adding the relevant file in the SciTools/.github
templates/directory. 1 - Raise an issue against the SciTools/.github repo for the above action if you really don't have 10mins spare right now. Include an assignee, to avoid it being forgotten.
- Dismiss the suggestion if the changes are not suitable for templating.
You will need to dismiss this review before this PR can be merged. Recommend the reviewer does this as their final action before merging, as this text will continually update as commits come in.
Templated files
The following changed files are templated:
-
.lycheeignore, templated bySciTools/.github/templates/.lycheeignore
Template candidates
The following changed files are not currently templated, but their parent directories suggest they may be good candidates for a new template to be created:
Footnotes
-
Include this text in the PR body to avoid any notifications about applying the template changes back to the source repo!
@scitools-templating: please no update notification on: iris↩
⏱️ Performance Benchmark Report: ba8b362Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: fe26eb3Performance shiftsFull benchmark resultsGenerated by GHA run |
stephenworsley
left a comment
There was a problem hiding this comment.
Looking pretty close now, just a couple small comments.
⏱️ Performance Benchmark Report: 421e7e4Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 1f6495cPerformance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 6c29502Performance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: 4fa1aaaPerformance shiftsFull benchmark resultsGenerated by GHA run |
stephenworsley
left a comment
There was a problem hiding this comment.
Looks good. Good job getting this over the line!
Changes to templatable files were all too Iris specific to pull into a broader template.
|
Thanks @stephenworsley! |
Closes #6511
Unfortunately a fair bit left to do.
Examples- in Diataxis these should be short-and-sweet, with the remaining richness moved to dedicated How-To pagesFor the reviewer
I suggest reading the PR commit-by-commit. I have done my best to create atomic/meaningful commits to make this PR easier to handle.
Planned restructure
Click to expand
further_topics/dataless_cubes.rst->explanation/dataless_cubes.rstuserguide/iris_cubes.rst->explanation/iris_cubes.rstuserguide/iris_philosophy.rst->explanation/iris_philosophy.rstsplit into sub-files?community/iris_xarray.rst->explanation/iris_xarray.rstfurther_topics/lenient_maths.rst->explanation/lenient_maths.rstfurther_topics/lenient_metadata.rst->explanation/lenient_metadata.rstfurther_topics/ugrid/data_model.rst->explanation/mesh_data_model.rstfurther_topics/ugrid/partner_packages.rst->explanation/mesh_partners.rstfurther_topics/metadata.rst->explanation/metadata.rstfurther_topics/missing_data_handling.rst->explanation/missing_data_handling.rstfurther_topics/netcdf_io.rst->explanation/netcdf_io.rstuserguide/real_and_lazy_data.rst->explanation/real_and_lazy_data.rstfurther_topics/um_files_loading.rst->explanation/um_files_loading.rstfurther_topics/which_regridder_to_use.rst->explanation/which_regridder_to_use.rstgenerated/api/iris.analysis.calculus.rst->generated/api/iris.analysis.calculus.rstlink from referencegenerated/api/iris.analysis.cartography.rst->generated/api/iris.analysis.cartography.rstlink from referencegenerated/api/iris.analysis.geometry.rst->generated/api/iris.analysis.geometry.rstlink from referencegenerated/api/iris.analysis.maths.rst->generated/api/iris.analysis.maths.rstlink from referencegenerated/api/iris.analysis.rst->generated/api/iris.analysis.rstlink from referencegenerated/api/iris.analysis.stats.rst->generated/api/iris.analysis.stats.rstlink from referencegenerated/api/iris.analysis.trajectory.rst->generated/api/iris.analysis.trajectory.rstlink from referencegenerated/api/iris.aux_factory.rst->generated/api/iris.aux_factory.rstlink from referencegenerated/api/iris.common.lenient.rst->generated/api/iris.common.lenient.rstlink from referencegenerated/api/iris.common.metadata.rst->generated/api/iris.common.metadata.rstlink from referencegenerated/api/iris.common.mixin.rst->generated/api/iris.common.mixin.rstlink from referencegenerated/api/iris.common.resolve.rst->generated/api/iris.common.resolve.rstlink from referencegenerated/api/iris.common.rst->generated/api/iris.common.rstlink from referencegenerated/api/iris.config.rst->generated/api/iris.config.rstlink from referencegenerated/api/iris.coord_categorisation.rst->generated/api/iris.coord_categorisation.rstlink from referencegenerated/api/iris.coord_systems.rst->generated/api/iris.coord_systems.rstlink from referencegenerated/api/iris.coords.rst->generated/api/iris.coords.rstlink from referencegenerated/api/iris.cube.rst->generated/api/iris.cube.rstlink from referencegenerated/api/iris.exceptions.rst->generated/api/iris.exceptions.rstlink from referencegenerated/api/iris.experimental.animate.rst->generated/api/iris.experimental.animate.rstlink from referencegenerated/api/iris.experimental.geovista.rst->generated/api/iris.experimental.geovista.rstlink from referencegenerated/api/iris.experimental.regrid.rst->generated/api/iris.experimental.regrid.rstlink from referencegenerated/api/iris.experimental.regrid_conservative.rst->generated/api/iris.experimental.regrid_conservative.rstlink from referencegenerated/api/iris.experimental.representation.rst->generated/api/iris.experimental.representation.rstlink from referencegenerated/api/iris.experimental.rst->generated/api/iris.experimental.rstlink from referencegenerated/api/iris.experimental.stratify.rst->generated/api/iris.experimental.stratify.rstlink from referencegenerated/api/iris.experimental.ugrid.rst->generated/api/iris.experimental.ugrid.rstlink from referencegenerated/api/iris.fileformats.abf.rst->generated/api/iris.fileformats.abf.rstlink from referencegenerated/api/iris.fileformats.cf.rst->generated/api/iris.fileformats.cf.rstlink from referencegenerated/api/iris.fileformats.dot.rst->generated/api/iris.fileformats.dot.rstlink from referencegenerated/api/iris.fileformats.name.rst->generated/api/iris.fileformats.name.rstlink from referencegenerated/api/iris.fileformats.name_loaders.rst->generated/api/iris.fileformats.name_loaders.rstlink from referencegenerated/api/iris.fileformats.netcdf.loader.rst->generated/api/iris.fileformats.netcdf.loader.rstlink from referencegenerated/api/iris.fileformats.netcdf.rst->generated/api/iris.fileformats.netcdf.rstlink from referencegenerated/api/iris.fileformats.netcdf.saver.rst->generated/api/iris.fileformats.netcdf.saver.rstlink from referencegenerated/api/iris.fileformats.netcdf.ugrid_load.rst->generated/api/iris.fileformats.netcdf.ugrid_load.rstlink from referencegenerated/api/iris.fileformats.nimrod.rst->generated/api/iris.fileformats.nimrod.rstlink from referencegenerated/api/iris.fileformats.nimrod_load_rules.rst->generated/api/iris.fileformats.nimrod_load_rules.rstlink from referencegenerated/api/iris.fileformats.pp.rst->generated/api/iris.fileformats.pp.rstlink from referencegenerated/api/iris.fileformats.pp_load_rules.rst->generated/api/iris.fileformats.pp_load_rules.rstlink from referencegenerated/api/iris.fileformats.pp_save_rules.rst->generated/api/iris.fileformats.pp_save_rules.rstlink from referencegenerated/api/iris.fileformats.rst->generated/api/iris.fileformats.rstlink from referencegenerated/api/iris.fileformats.rules.rst->generated/api/iris.fileformats.rules.rstlink from referencegenerated/api/iris.fileformats.um.rst->generated/api/iris.fileformats.um.rstlink from referencegenerated/api/iris.fileformats.um_cf_map.rst->generated/api/iris.fileformats.um_cf_map.rstlink from referencegenerated/api/iris.io.format_picker.rst->generated/api/iris.io.format_picker.rstlink from referencegenerated/api/iris.io.rst->generated/api/iris.io.rstlink from referencegenerated/api/iris.iterate.rst->generated/api/iris.iterate.rstlink from referencegenerated/api/iris.loading.rst->generated/api/iris.loading.rstlink from referencegenerated/api/iris.mesh.components.rst->generated/api/iris.mesh.components.rstlink from referencegenerated/api/iris.mesh.rst->generated/api/iris.mesh.rstlink from referencegenerated/api/iris.mesh.utils.rst->generated/api/iris.mesh.utils.rstlink from referencegenerated/api/iris.palette.rst->generated/api/iris.palette.rstlink from referencegenerated/api/iris.pandas.rst->generated/api/iris.pandas.rstlink from referencegenerated/api/iris.plot.rst->generated/api/iris.plot.rstlink from referencegenerated/api/iris.quickplot.rst->generated/api/iris.quickplot.rstlink from referencegenerated/api/iris.rst->generated/api/iris.rstlink from referencegenerated/api/iris.std_names.rst->generated/api/iris.std_names.rstlink from referencegenerated/api/iris.symbols.rst->generated/api/iris.symbols.rstlink from referencegenerated/api/iris.time.rst->generated/api/iris.time.rstlink from referencegenerated/api/iris.util.rst->generated/api/iris.util.rstlink from referencegenerated/api/iris.warnings.rst->generated/api/iris.warnings.rstlink from referencegenerated/gallery/general/index.rst->generated/gallery/general/index.rstlink from how_togenerated/gallery/general/plot_anomaly_log_colouring.rst->generated/gallery/general/plot_anomaly_log_colouring.rstlink from how_togenerated/gallery/general/plot_coriolis.rst->generated/gallery/general/plot_coriolis.rstlink from how_togenerated/gallery/general/plot_cross_section.rst->generated/gallery/general/plot_cross_section.rstlink from how_togenerated/gallery/general/plot_custom_aggregation.rst->generated/gallery/general/plot_custom_aggregation.rstlink from how_togenerated/gallery/general/plot_custom_file_loading.rst->generated/gallery/general/plot_custom_file_loading.rstlink from how_togenerated/gallery/general/plot_global_map.rst->generated/gallery/general/plot_global_map.rstlink from how_togenerated/gallery/general/plot_inset.rst->generated/gallery/general/plot_inset.rstlink from how_togenerated/gallery/general/plot_lineplot_with_legend.rst->generated/gallery/general/plot_lineplot_with_legend.rstlink from how_togenerated/gallery/general/plot_polar_stereo.rst->generated/gallery/general/plot_polar_stereo.rstlink from how_togenerated/gallery/general/plot_polynomial_fit.rst->generated/gallery/general/plot_polynomial_fit.rstlink from how_togenerated/gallery/general/plot_projections_and_annotations.rst->generated/gallery/general/plot_projections_and_annotations.rstlink from how_togenerated/gallery/general/plot_rotated_pole_mapping.rst->generated/gallery/general/plot_rotated_pole_mapping.rstlink from how_togenerated/gallery/general/plot_SOI_filtering.rst->generated/gallery/general/plot_SOI_filtering.rstlink from how_togenerated/gallery/general/plot_zonal_means.rst->generated/gallery/general/plot_zonal_means.rstlink from how_togenerated/gallery/general/sg_execution_times.rst->generated/gallery/general/sg_execution_times.rstlink from how_togenerated/gallery/index.rst->generated/gallery/index.rstlink from how_togenerated/gallery/meteorology/index.rst->generated/gallery/meteorology/index.rstlink from how_togenerated/gallery/meteorology/plot_COP_1d.rst->generated/gallery/meteorology/plot_COP_1d.rstlink from how_togenerated/gallery/meteorology/plot_COP_maps.rst->generated/gallery/meteorology/plot_COP_maps.rstlink from how_togenerated/gallery/meteorology/plot_deriving_phenomena.rst->generated/gallery/meteorology/plot_deriving_phenomena.rstlink from how_togenerated/gallery/meteorology/plot_hovmoller.rst->generated/gallery/meteorology/plot_hovmoller.rstlink from how_togenerated/gallery/meteorology/plot_lagged_ensemble.rst->generated/gallery/meteorology/plot_lagged_ensemble.rstlink from how_togenerated/gallery/meteorology/plot_TEC.rst->generated/gallery/meteorology/plot_TEC.rstlink from how_togenerated/gallery/meteorology/plot_wind_barbs.rst->generated/gallery/meteorology/plot_wind_barbs.rstlink from how_togenerated/gallery/meteorology/plot_wind_speed.rst->generated/gallery/meteorology/plot_wind_speed.rstlink from how_togenerated/gallery/meteorology/sg_execution_times.rst->generated/gallery/meteorology/sg_execution_times.rstlink from how_togenerated/gallery/oceanography/index.rst->generated/gallery/oceanography/index.rstlink from how_togenerated/gallery/oceanography/plot_atlantic_profiles.rst->generated/gallery/oceanography/plot_atlantic_profiles.rstlink from how_togenerated/gallery/oceanography/plot_load_nemo.rst->generated/gallery/oceanography/plot_load_nemo.rstlink from how_togenerated/gallery/oceanography/plot_orca_projection.rst->generated/gallery/oceanography/plot_orca_projection.rstlink from how_togenerated/gallery/oceanography/sg_execution_times.rst->generated/gallery/oceanography/sg_execution_times.rstlink from how_togenerated/gallery/sg_execution_times.rst->generated/gallery/sg_execution_times.rstlink from how_togetting_started.rst->user_manual/section_indexes/get_startedReference a minimum: Data Structures, Loading Iris Cubes up to end of Lazy Loadinginstalling.rst->how_to/installing.rstwhy_iris.rst->explanation/why_iris.rstfurther_topics/index.rst->GONEnew structurefurther_topics/filtering_warnings.rst->how_to/filtering_warnings.rstfurther_topics/ugrid/other_meshes.rst->how_to/mesh_conversions.rstfurther_topics/ugrid/operations.rst->how_to/mesh_operations.rstuserguide/navigating_a_cube.rst->how_to/navigating_a_cube.rstcommunity/plugins.rst->how_to/plugins.rstindex.rst->index.rstcopyright.rst->copyright.rstuserguide/glossary.rst->reference/glossary.rstcommunity/phrasebook.rst->reference/phrasebook.rstuserguide/index.rst->REPLACEneed a new statement on the minimum reading requirementsg_execution_times.rst->sg_execution_times.rstfurther_topics/controlling_merge.rst->tutorial/controlling_merge.rstuserguide/cube_maths.rst->tutorial/cube_maths.rstuserguide/cube_statistics.rst->tutorial/cube_statistics.rstfurther_topics/dask_best_practices/dask_bags_and_greed.rst->tutorial/dask_best_practices/dask_bags_and_greed.rstfurther_topics/dask_best_practices/dask_parallel_loop.rst->tutorial/dask_best_practices/dask_parallel_loop.rstfurther_topics/dask_best_practices/dask_pp_to_netcdf.rst->tutorial/dask_best_practices/dask_pp_to_netcdf.rstfurther_topics/dask_best_practices/index.rst->tutorial/dask_best_practices/index.rstuserguide/interpolation_and_regridding.rst->tutorial/interpolation_and_regridding.rstuserguide/loading_iris_cubes.rst->tutorial/loading_iris_cubes.rstuserguide/merge_and_concat.rst->tutorial/merge_and_concat.rstuserguide/plotting_a_cube.rst->tutorial/plotting_a_cube.rstuserguide/saving_iris_cubes.rst->tutorial/saving_iris_cubes.rstuserguide/subsetting_a_cube.rst->tutorial/subsetting_a_cube.rstwhatsnew/1.0.rst->whatsnew/1.0.rsttoctree = referencewhatsnew/1.1.rst->whatsnew/1.1.rsttoctree = referencewhatsnew/1.10.rst->whatsnew/1.10.rsttoctree = referencewhatsnew/1.11.rst->whatsnew/1.11.rsttoctree = referencewhatsnew/1.12.rst->whatsnew/1.12.rsttoctree = referencewhatsnew/1.13.rst->whatsnew/1.13.rsttoctree = referencewhatsnew/1.2.rst->whatsnew/1.2.rsttoctree = referencewhatsnew/1.3.rst->whatsnew/1.3.rsttoctree = referencewhatsnew/1.4.rst->whatsnew/1.4.rsttoctree = referencewhatsnew/1.5.rst->whatsnew/1.5.rsttoctree = referencewhatsnew/1.6.rst->whatsnew/1.6.rsttoctree = referencewhatsnew/1.7.rst->whatsnew/1.7.rsttoctree = referencewhatsnew/1.8.rst->whatsnew/1.8.rsttoctree = referencewhatsnew/1.9.rst->whatsnew/1.9.rsttoctree = referencewhatsnew/2.0.rst->whatsnew/2.0.rsttoctree = referencewhatsnew/2.1.rst->whatsnew/2.1.rsttoctree = referencewhatsnew/2.2.rst->whatsnew/2.2.rsttoctree = referencewhatsnew/2.3.rst->whatsnew/2.3.rsttoctree = referencewhatsnew/2.4.rst->whatsnew/2.4.rsttoctree = referencewhatsnew/3.0.rst->whatsnew/3.0.rsttoctree = referencewhatsnew/3.1.rst->whatsnew/3.1.rsttoctree = referencewhatsnew/3.10.rst->whatsnew/3.10.rsttoctree = referencewhatsnew/3.11.rst->whatsnew/3.11.rsttoctree = referencewhatsnew/3.12.rst->whatsnew/3.12.rsttoctree = referencewhatsnew/3.13.rst->whatsnew/3.13.rsttoctree = referencewhatsnew/3.14.rst->whatsnew/3.14.rsttoctree = referencewhatsnew/3.2.rst->whatsnew/3.2.rsttoctree = referencewhatsnew/3.3.rst->whatsnew/3.3.rsttoctree = referencewhatsnew/3.4.rst->whatsnew/3.4.rsttoctree = referencewhatsnew/3.5.rst->whatsnew/3.5.rsttoctree = referencewhatsnew/3.6.rst->whatsnew/3.6.rsttoctree = referencewhatsnew/3.7.rst->whatsnew/3.7.rsttoctree = referencewhatsnew/3.8.rst->whatsnew/3.8.rsttoctree = referencewhatsnew/3.9.rst->whatsnew/3.9.rsttoctree = referencewhatsnew/index.rst->whatsnew/index.rsttoctree = referencewhatsnew/latest.rst->whatsnew/latest.rsttoctree = referenceDetails