202101 public release

README.md

@@ -1,13 +1,12 @@
 # GFDL_atmos_cubed_sphere
 
-The source contained herein reflects the 201912 release of the Finite Volume Cubed-Sphere Dynamical Core (FV3) from GFDL
+The source contained herein reflects the 202101 release of the Finite Volume Cubed-Sphere Dynamical Core (FV3) from GFDL
 
 The GFDL Microphysics is also available via this repository.
 
 # Where to find information
 
-See the [FV3 documentation and references](https://www.gfdl.noaa.gov/fv3/fv3-documentation-and-references/)
-for more information.
+Visit the [FV3 website](https://www.gfdl.noaa.gov/fv3/) for more information. Reference material is available at [FV3 documentation and references](https://www.gfdl.noaa.gov/fv3/fv3-documentation-and-references/). 
 
 # Proper usage attribution
 
@@ -22,10 +21,17 @@ The top level directory structure groups source code and input files as follow:
 | --------------       | ------- |
 | ```LICENSE.md```     | a copy of the Gnu lesser general public license, version 3. |
 | ```README.md```      | this file with basic pointers to more information |
+| ```RELEASE.md```     | notes describing each release in the main branch |
 | ```model/```         | contains the source code for core of the FV3 dyanmical core |
 | ```driver/```        | contains drivers used by different models/modeling systems |
 | ```tools/```         | contains source code of tools used within the core |
 | ```GFDL_tools/```    | contains source code of tools specific to GFDL models |
+| ```docs/```          | contains documentation for the FV3 dynamical core |
+
+# Generating PDF Documentation
+To update the ```refmans.pdf``` file:
+1. In the ```docs/``` directory enter the command ```doxygen Doxyfile```
+2. Navigate to the ```latex/``` directory and enter the command ```make pdf```
 
 # Disclaimer
 

RELEASE.md

@@ -1,4 +1,31 @@
-# RELEASE NOTES for FV3: Summary
+# RELEASE NOTES for FV3 202101: Summary
+
+FV3-202101-public --- 22 January 2021
+Lucas Harris, GFDL <lucas.harris@noaa.gov>
+
+This version has been tested against the current SHiELD (formerly fvGFS) physics
+and with FMS release candidate 2020.04 from https://github.com/NOAA-GFDL/FMS
+
+This release includes the following:
+
+- Positive-definite advection scheme
+- In-line GFDL Microphysics
+- Fast-timescale Rayleigh damping
+- Updated namelist documentation
+- Implemented multiple same-level and telescoping nests for the global system (from J Mouallem)
+- Updated coarse-graining capabilities (from S Clark)
+- Re-organized fv_diagnostics, moving the revised fv_diag_column functionality and the declaration of diagnostic IDs to separate files
+- and other updates and general cleanup
+
+This version of FV3 is described as component of SHiELD in Harris et al. (2020, JAMES).
+
+## Interface changes in 202101
+
+drivers: renamed 'fvGFS' directory to SHiELD
+
+atmosphere.F90: if using the in-line GFDL microphysics the precipitation rates (available in the structure Atm%inline_mp for rain, ice, snow, and graupel separately) must be passed into the physics and/or land model as appropriate. Here we demonstrate how to do this in SHiELD by copying them into IPD_Data(nb)%Statein%prep (and so on), which are newly defined in the IPD_Data structure within the SHiELD physics.
+
+# RELEASE NOTES for FV3 201912: Summary
 
 FV3-201912-public --- 10 January 2020
 Lucas Harris, GFDL <lucas.harris@noaa.gov>
@@ -18,7 +45,7 @@ Includes all of the features of the GFDL Release to EMC, as well as:
 - Support for point soundings
 - And other updates
 
-# Interface changes
+## Interface changes
 
 drivers: renamed 'fvGFS' directory to SHiELD