Add documentation for unified framework and testcases

MPAS-Dev · Sep 13, 2024 · bdae362 · bdae362
1 parent b281644
commit bdae362
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 8 deletions.
diff --git a/docs/developers_guide/landice/framework.rst b/docs/developers_guide/landice/framework.rst
@@ -56,13 +56,10 @@ clean up steps after interpolation for the AIS mesh case.
 :py:func:`compass.landice.mesh.gridded_flood_fill()` applies a flood-fill algorithm
 to the gridded dataset in order to separate the ice sheet from peripheral ice.
 
-:py:func:`compass.landice.mesh.interp_ais_bedmachine()` interpolates BedMachine
-thickness and bedTopography dataset to a MALI mesh, accounting for masking of
-the ice extent to avoid interpolation ramps.
-
-:py:func:`compass.landice.mesh.interp_ais_interp_ais_measures()` interpolates
-MEASURES ice velocity dataset to a MALI mesh, accounting for masking at the ice
-edge and extrapolation.
+:py:func:`compass.landice.mesh.interp_gridded2mali()` interpolates gridded data
+(e.g. BedMachine thickness or MEASURES ice velocity) to a MALI mesh, accounting
+for masking of the ice extent to avoid interpolation ramps. This functions works
+for either the Antarctic or Greenland Icesheets. 
 
 :py:func:`compass.landice.mesh.preprocess_ais_data()` performs adjustments to
 gridded AIS datasets needed for rest of compass workflow to utilize them.

diff --git a/docs/users_guide/landice/test_groups/antarctica.rst b/docs/users_guide/landice/test_groups/antarctica.rst
@@ -73,7 +73,19 @@ the mesh generation options are adjusted through the config file.
     # path to directory containing BedMachine and Measures datasets
     # (default value is for Perlmutter)
     data_path = /global/cfs/cdirs/fanssie/standard_datasets/AIS_datasets
-
+    
+    # filename of the BedMachine thickness and bedTopography dataset
+    # (default value is for Perlmutter)
+    bedmachine_filename = BedMachineAntarctica_2020-07-15_v02_edits_floodFill_extrap_fillVostok.nc
+    
+    # filename of the MEASURES ice velocity dataset
+    # (default value is for Perlmutter)
+    measures_filename = antarctica_ice_velocity_450m_v2_edits_extrap.nc
+    
+    # projection of the source datasets, according to the dictionary keys
+    # create_SCRIP_file_from_planar_rectangular_grid.py from MPAS_Tools
+    src_proj = ais-bedmap2
+    
     # number of processors to use for ESMF_RegridWeightGen
     nProcs = 128
 

diff --git a/docs/users_guide/landice/test_groups/greenland.rst b/docs/users_guide/landice/test_groups/greenland.rst
@@ -86,6 +86,26 @@ The other test cases do not use config options.
    use_dist_to_edge = True
    use_bed = True
 
+   [greenland]
+   # path to directory containing BedMachine and Measures datasets
+   # (default value is for Perlmutter)
+   data_path = /global/cfs/cdirs/fanssie/standard_datasets/GIS_datasets/
+   
+   # filename of the BedMachine thickness and bedTopography dataset
+   # (default value is for Perlmutter)
+   bedmachine_filename = BedMachineGreenland-v5_edits_floodFill_extrap.nc
+   
+   # filename of the MEASURES ice velocity dataset
+   # (default value is for Perlmutter)
+   measures_filename = greenland_vel_mosaic500_extrap.nc
+   
+   # projection of the source datasets, according to the dictionary keys
+   # create_SCRIP_file_from_planar_rectangular_grid.py from MPAS_Tools
+   src_proj = gis-gimp
+   
+   # number of processors to use for ESMF_RegridWeightGen
+   nProcs = 128
+
 smoke_test
 ----------