Merge pull request #371 from wwieder/clm-diags

Updates for LDF

Author: wwieder

LAND-DIAGS_README.md

@@ -1,3 +1,47 @@
+### Here's a quick start that you can use for Land Diagnostics
+#### Download the adf repo
+On casper:
+1. Navigate to the directory where you want the adf (e.g., `cd ~`)
+2. Clone the ADF
+`git clone https://github.com/NCAR/ADF.git`
+3. Set your personal repository as the upstream repo
+```
+cd ADF
+git remote add upstream https://github.com/<git_user_name>/ADF.git
+```
+4. Switch to the clm-diags branch
+`git switch -c clm-diags origin/clm-diags`
+
+#### Set up your computing environment
+1. Create a conda environment. On NCAR's CISL machines (derecho and casper), these can be loaded by running the following on the command line:
+```
+module load conda
+conda env create -f env/ldf_v0.0.yaml
+conda activate ldf_v0.0
+```
+
+**Note** This is somewhat redundant, as it's a clone of cupid-analysis, but land diagnostics need the latest version of uxarray (25.3.0), and this will prevent overwriting your other conda environments.
+
+Also, along with these python requirements, the `ncrcat` NetCDF Operator (NCO) is also needed.  On the CISL machines this can be loaded by simply running:
+```
+module load nco/5.2.4
+```
+on the command line.
+_Note_, I'm not sure specifying the nco version is critical, but it does seem to help get around an issues where nco errors seemed to prevent additiof area and landfrac onto timeseries files when using the default 5.3.1 version of NCO on casper.
+
+## Running ADF diagnostics
+
+Detailed instructions for users and developers are availabe on this repository's [wiki](https://github.com/NCAR/ADF/wiki).
+
+`./run_adf_diag config_clm_unstructured_plots.yaml`
+
+This should generate a collection of time series files, climatology (climo) files, re-gridded climo files, and example ADF diagnostic figures, all in their respective directories.
+
+If you get NCO failures at the generate timeseries stage that end up causing LDF to fail, see issue [#365](https://github.com/NCAR/ADF/issues/365) 
+
+When additional memory is needed sometimes need to run interactive session on casper:
+`execcasper -A P93300041 -l select=1:ncpus=4:mem=64GB`
+
 ## TEST for Land Diags:
 
 For this branch there are (3) ways to run the ADF:
@@ -10,7 +54,7 @@ For (1), the config yaml file will be essentially the same, but with a couple of
   - in `diag_basic_info` set the `unstructured_plotting` argument to `true`
   - in each of the test and baseline section supply a mesh file in the `mesh_file` argument
 
-  Example yaml file: `config_unstructured_plots.yaml`
+  Example yaml file: `config_clm_unstructured_plots.yaml`
 
 For (2), the config yaml file will need some additional arguments:
   - in each of the test and baseline sections, supply the following arguments:
@@ -21,14 +65,15 @@ For (2), the config yaml file will need some additional arguments:
 
     Regridding method:
 
-    `regrid_method: 'conservative'`
-    
+    `regrid_method: 'coservative'`
+    (Yes, spelled incorectly for a bug in xESMF)
+
     Lat/lon file:
 
     `latlon_file: /glade/derecho/scratch/wwieder/ctsm5.3.018_SP_f09_t232_mask/run/ctsm5.3.018_SP_f09_t232_mask.clm2.h0.0001-01.nc`
 
   NOTE: The regridding method set in `regrid_method` MUST match the method in the weights file
 
-  Example yaml file: `config_ldf_native_grid_to_latlon.yaml`
+  Example yaml file: `config_clm_native_grid_to_latlon.yaml`