Add output variable CSV tables as A17

docs/BUILD.rst

@@ -101,7 +101,7 @@ Future commands will reconfigure the ``Run`` directory.
 +=================================+
 | make croton                     |
 +---------------------------------+
-| makep croton-gridded            |
+| make croton-gridded             |
 +---------------------------------+
 | make croton-gridded-no-lakes    |
 +---------------------------------+

docs/userguide/appendices.rest

@@ -2593,53 +2593,74 @@ layers contain the initialized ice.
 A17. Model Output Variables
 ---------------------------------------------
 
-.. rubric:: 1. Land surface model output variables
+A17.1. Land surface model output variables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-\
    :file:`{YYYYMMDDHHMM}.LDASOUT_DOMAIN{X}`
 
-.. rubric:: 2. Land surface diagnostic output variables
+   .. csv-table:: LDASOUT
+      :file: output-tables/LDASOUT_DOMAIN.csv
+      :header-rows: 1
+
+A17.2. Land surface diagnostic output variables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-\
    :file:`{YYYYMMDDHHMM}.LSMOUT_DOMAIN{X}`
 
+   .. csv-table:: LSMOUT
+      :file: output-tables/LSMOUT.csv
+      :header-rows: 1
 
-.. rubric:: 3. Streamflow output variables at all channel reaches/cells
+A17.3. Streamflow output variables at all channel reaches/cells
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-\
    :file:`{YYYYMMDDHHMM}.CHRTOUT_DOMAIN{X}`
 
+   .. csv-table:: CHRTOUT
+      :file: output-tables/CHRTOUT_DOMAIN.csv
+      :header-rows: 1
 
+A17.4. Streamflow output variables at forecast points or gage reaches/cells
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. rubric:: 4. Streamflow output variables at forecast points or gage reaches/cells
-
-\
    :file:`{YYYYMMDDHHMM}.CHANOBS_DOMAIN{X}`
 
+   .. csv-table:: CHANOBS_DOMAIN
+      :file: output-tables/CHANOBS_DOMAIN.csv
+      :header-rows: 1
 
+A17.5. Streamflow output variables on the 2D high resolution routing grid
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. rubric:: 5. Streamflow output variables on the 2D high resolution routing grid
-
-\
    :file:`{YYYYMMDDHHMM}.CHRTOUT_GRID{X}`
 
+   .. csv-table:: CHRTOUT_GRID
+      :file: output-tables/CHRTOUT_GRID.csv
+      :header-rows: 1
 
+A17.6. Terrain routing variables on the 2D high resolution routing grid
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. rubric:: 6. Terrain routing variables on the 2D high resolution routing grid
-
-\
    :file:`{YYYYMMDDHHMM}.RTOUT_DOMAIN{X}`
 
+   .. csv-table:: RTOUT
+      :file: output-tables/RTOUT_DOMAIN.csv
+      :header-rows: 1
 
+A17.7. Lake output variables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. rubric:: 7. Lake output variables
-
-\
    :file:`{YYYYMMDDHHMM}.LAKEOUT_DOMAIN{X}`
 
+   .. csv-table:: LAKEOUT
+      :file: output-tables/LAKEOUT_DOMAIN.csv
+      :header-rows: 1
 
+A17.8. Ground water output variables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. rubric:: 8. Ground water output variables
-
-\
    :file:`{YYYYMMDDHHMM}.GWOUT_DOMAIN{X}`
+
+   .. csv-table:: GWOUT
+      :file: output-tables/GWOUT_DOMAIN.csv
+      :header-rows: 1

docs/userguide/output-tables/CHANOBS_DOMAIN.csv

@@ -0,0 +1,9 @@
+Variable Name,Long Name,Description,Units,IO_ConfigOutputs_0,IO_ConfigOutputs_1,IO_ConfigOutputs_2,IO_ConfigOutputs_3,IO_ConfigOutputs_4,IO_ConfigOutputs_5,IO_ConfigOutputs_6,Min,Max,Scale,Offset,Fill
+time,valid output time,Valid output time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+reference_time,model initialization time,Model initialization time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+feature_id,Reach ID,Unique reach or channel cell ID,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+latitude,Feature latitude,Station latitude,decimal degrees,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+longitude,Feature longitude,Station longitude,decimal degrees,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+order,Streamflow Order,Strahler stream order for output reach or cell,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+elevation,Feature Elevation,Elevation for output reach or cell,m,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+streamflow,River Flow,Streamflow,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,0,500000,0.01,0,-9999

docs/userguide/output-tables/CHRTOUT_DOMAIN.csv

@@ -0,0 +1,18 @@
+Variable Name,Long Name,Description,Units,IO_ConfigOutputs_0,IO_ConfigOutputs_1,IO_ConfigOutputs_2,IO_ConfigOutputs_3,IO_ConfigOutputs_4,IO_ConfigOutputs_5,IO_ConfigOutputs_6,Min,Max,Scale,Offset,Fill,Special Notes
+time,valid output time,Valid output time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+reference_time,model initialization time,Model initialization time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+feature_id,Reach ID,Unique reach or channel cell ID,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+latitude,Feature latitude,Station latitude,decimal degrees,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+longitude,Feature Longitude,Station longitude,decimal degrees,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+order,Streamflow order,Strahler stream order for output reach or cell,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+elevation,Feature Elevation,Elevation for output reach or cell,m,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A,
+streamflow,River Flow,Streamflow,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,0,500000,0.01,0,-9999,
+nudge,Amount of stream flow alteration,Streamflow nudge value (only if nudging DA is active),m3 s-1,No,No,No,No,No,No,No,-500000,500000,0.01,0,-9999,Values only when nudging DA is active
+q_lateral,Runoff into channel reach,Lateral flow into channel reach or cell,m3 s-1,Yes,No,No,No,No,Yes,Yes,0,500000,0.1,0,-9999,
+velocity,River Velocity,Channel velocity,m s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,0,500000,0.01,0,-9999,
+head,River Stage,River stage (gridded channel only),m,Yes,No,No,No,No,No,No,0,500000,0.01,0,-9999,
+qSfcLatRunoff,Runoff from terrain routing,Flux from terrain routing,m3 s-1,No,No,No,No,No,No,No,0,500000,0.001,0,-9999,Only available for UDMP_OPT=1
+qBucket,Flux from gw bucket,Flux from groundwater buckets,m3 s-1,No,No,No,No,No,No,No,0,500000,0.001,0,-9999,Only available for UDMP_OPT=1
+qBtmVertRunoff,Runoff from bottom of soil to bucket,Flux from bottom of soil column into groundwater buckets,m3,No,No,No,No,No,No,No,0,500000,0.001,0,-9999,Only available for UDMP_OPT=1
+AccSfcLatRunoff,Accumulated runoff from terrain routing,Accumulated flux from terrain routing,m3,No,No,No,No,No,No,No,0,500000,0.01,0,-9999,Only available for UDMP_OPT=1
+accBucket,Accumulated runoff from gw bucket,Accumulated flux from groundwater buckets,m3,No,No,No,No,No,No,No,0,500000,0.01,0,-9999,Only available for UDMP_OPT=1

docs/userguide/output-tables/CHRTOUT_GRID.csv

@@ -0,0 +1,7 @@
+Variable Name,Long Name,Description,Units,IO_ConfigOutputs_0,IO_ConfigOutputs_1,IO_ConfigOutputs_2,IO_ConfigOutputs_3,IO_ConfigOutputs_4,IO_ConfigOutputs_5,IO_ConfigOutputs_6,Min,Max,Scale,Offset,Fill
+time,valid output time,Valid output time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+reference_time,model initialization time,Model initialization time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+x,x coordinate of projection,x coordinate (in native projection),native projection units,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+y,y coordinate of projection,y coordinate (in native projection),native projection units,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+Index,Stream cell index value,Stream cell index value,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+streamflow,River Flow,Streamflow,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,0,500000,0.1,0,-9999

docs/userguide/output-tables/GWOUT_DOMAIN.csv

@@ -0,0 +1,7 @@
+Variable Name,Long Name,Description,Units,IO_ConfigOutputs_0,IO_ConfigOutputs_1,IO_ConfigOutputs_2,IO_ConfigOutputs_3,IO_ConfigOutputs_4,IO_ConfigOutputs_5,IO_ConfigOutputs_6,Min,Max,Scale,Offset,Fill
+time,valid output time,Valid output time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+reference_time,model initialization time,Model initialization time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+feature_id,Groundwater Bucket ID,Unique groundwater bucket ID,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+inflow,Bucket Inflow,Total groundwater bucket inflow,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,-10000,10000,0.01,0,-9999
+outflow,Bucket Outflow,Total groundwater bucket outflow,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,-10000,10000,0.01,0,-9999
+depth,Bucket Depth,Groundwater bucket water level,mm,Yes,Yes,Yes,Yes,Yes,Yes,Yes,-10000,10000,0.1,0,-9999

docs/userguide/output-tables/LAKEOUT_DOMAIN.csv

@@ -0,0 +1,9 @@
+Variable Name,Long Name,Description,Units,IO_ConfigOutputs_0,IO_ConfigOutputs_1,IO_ConfigOutputs_2,IO_ConfigOutputs_3,IO_ConfigOutputs_4,IO_ConfigOutputs_5,IO_ConfigOutputs_6,Min,Max,Scale,Offset,Fill
+time,valid output time,Valid output time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+reference_time,model initialization time,Model initialization time,minutes since 1970-01-01 00:00:00 UTC,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+feature_id,Lake COMMON ID,Unique lake ID,-,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+latitude,Lake latitude,Lake latitude,decimal degrees,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+longitude,Lake longitude,Lake longitude,decimal degrees,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+water_sfc_elev,Water Surface Elevation,Water surface elevation above sea level,m,Yes,Yes,Yes,Yes,Yes,Yes,Yes,N/A,N/A,N/A,N/A,N/A
+inflow,Lake Inflow,Total inflow into waterbody,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,-10000,10000,0.01,0,-9999
+outflow,Lake Outflow,Outflow from waterbody outlet,m3 s-1,Yes,Yes,Yes,Yes,Yes,Yes,Yes,-10000,10000,0.01,0,-9999