Remove Regridder module

Remove all unused functions from Regridder module.
Used functions relocated to Utilities and FieldExchanger
modules. Docs and tests appropriately updated.

.buildkite/pipeline.yml

@@ -65,16 +65,6 @@ steps:
 
   - group: "Unit Tests"
     steps:
-      - label: "MPI Regridder unit tests"
-        key: "regridder_mpi_tests"
-        command: "srun julia --color=yes --project=test/ test/mpi_tests/regridder_mpi_tests.jl"
-        timeout_in_minutes: 20
-        env:
-          CLIMACOMMS_CONTEXT: "MPI"
-          NPROCS: 2
-        agents:
-          slurm_ntasks: 2
-          slurm_mem: 16GB
 
       - label: "MPI Checkpointer unit tests"
         key: "checkpointer_mpi_tests"

NEWS.md

@@ -48,6 +48,46 @@ to our output diagnostics using the ClimaDiagnostics interface.
 This PR also removes the AMIP paperplots function, but this
 functionality is replaced by the generalized `make_plots` function.
 
+
+#### Remove ClimaCoupler.Regridder module - PR [#1109](https://github.com/CliMA/ClimaCoupler.jl/pull/1109)
+This PR removes the Regridder module. Most of the functions that were
+inside the module are available in [ClimaUtilities](https://github.com/CliMA/ClimaUtilities.jl/). Some functions were moved
+to other modules, and some unused functions were deleted.
+
+The functions:
+- `ClimaCoupler.Regridder.dummmy_remap!`
+- `ClimaCoupler.Regridder.update_surface_fractions!`
+- `ClimaCoupler.Regridder.combine_surfaces!`
+- `ClimaCoupler.Regridder.binary_mask`
+
+are now:
+- `ClimaCoupler.FieldExchanger.dummmy_remap!`
+- `ClimaCoupler.FieldExchanger.update_surface_fractions!`
+- `ClimaCoupler.FieldExchanger.combine_surfaces!`
+- `ClimaCoupler.Utilities.binary_mask`
+
+The following functions were removed from ClimaCoupler and have an equivalent in [ClimaUtilities](https://github.com/CliMA/ClimaUtilities.jl/tree/main):
+
+- `ClimaCoupler.Regridder.write_to_hdf5`
+- `ClimaCoupler.Regridder.read_from_hdf5`
+- `ClimaCoupler.Regridder.hdwrite_regridfile_rll_to_cgll`
+- `ClimaCoupler.Regridder.reshape_cgll_sparse_to_field!`
+- `ClimaCoupler.Regridder.get_time`
+
+Note that the the `hdwrite_regridfile_rll_to_cgll` in [ClimaUtilities](https://github.com/CliMA/ClimaUtilities.jl/tree/main) does not support 3d fields, but the removed function from the Regridder module did.
+
+The following functions were deleted and do not have an equivalent in [ClimaUtilities](https://github.com/CliMA/ClimaUtilities.jl/tree/main):
+
+- `ClimaCoupler.Regridder.remap_field_cgll_to_rll`
+- `ClimaCoupler.Regridder.land_fraction`
+- `ClimaCoupler.Regridder.combine_surfaces_from_sol!`
+- `ClimaCoupler.Regridder.write_datafile_cc`
+- `ClimaCoupler.Regridder.read_remapped_field`
+- `ClimaCoupler.Regridder.get_coords`
+
+All the above functions can be found in commit
+`9e5bf061f34659188485f066bc322c77bcc0f1fa`
+
 #### Remove PostProcessor module - PR [#1022](https://github.com/CliMA/ClimaCoupler.jl/pull/1022)
 After switching to use ClimaDiagnostics.jl and ClimaAnalysis.jl
 for our diagnostics, the PostProcessor module is not needed.

Project.toml

@@ -6,12 +6,8 @@ version = "0.1.1"
 [deps]
 ClimaComms = "3a4d1b5c-c61d-41fd-a00a-5873ba7a1b0d"
 ClimaCore = "d414da3d-4745-48bb-8d80-42e94e092884"
-ClimaCoreTempestRemap = "d934ef94-cdd4-4710-83d6-720549644b70"
-ClimaUtilities = "b3f4f4ca-9299-4f7f-bd9b-81e1242a7513"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
-JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
-NCDatasets = "85f8d34a-cbdd-5861-8df4-14fed0d494ab"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 SurfaceFluxes = "49b00bb7-8bd4-4f2b-b78c-51cd0450215f"
@@ -20,12 +16,8 @@ Thermodynamics = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 [compat]
 ClimaComms = "0.5.6, 0.6"
 ClimaCore = "0.14.19"
-ClimaCoreTempestRemap = "0.3"
-ClimaUtilities = "0.1.17"
 Dates = "1"
-JLD2 = "0.4, 0.5"
 Logging = "1"
-NCDatasets = "0.11, 0.12, 0.13, 0.14.2"
 SciMLBase = "1, 2"
 StaticArrays = "1.5"
 SurfaceFluxes = "0.11, 0.12"

docs/make.jl

@@ -62,7 +62,6 @@ interface_pages = [
     "fieldexchanger.md",
     "fluxcalculator.md",
     "interfacer.md",
-    "regridder.md",
     "timemanager.md",
     "utilities.md",
 ]

docs/src/fieldexchanger.md

@@ -22,4 +22,12 @@ If an `update_field!` function is not defined for a particular component model,
     ClimaCoupler.FieldExchanger.update_sim!
     ClimaCoupler.FieldExchanger.reinit_model_sims!
     ClimaCoupler.FieldExchanger.step_model_sims!
+    ClimaCoupler.FieldExchanger.update_surface_fractions!
+```
+
+## FieldExchanger Internal Functions
+
+```@docs
+    ClimaCoupler.FieldExchanger.combine_surfaces!
+    ClimaCoupler.FieldExchanger.dummmy_remap!
 ```

docs/src/utilities.md

@@ -13,4 +13,5 @@ ClimaCoupler.Utilities.get_device
 ClimaCoupler.Utilities.show_memory_usage
 ClimaCoupler.Utilities.setup_output_dirs
 ClimaCoupler.Utilities.time_to_seconds
+ClimaCoupler.Utilities.binary_mask
 ```