diff --git a/docs/Contributors_Guide/dev_details/static_data_files.rst b/docs/Contributors_Guide/dev_details/static_data_files.rst index 9677d6fb8..b44f3e255 100644 --- a/docs/Contributors_Guide/dev_details/static_data_files.rst +++ b/docs/Contributors_Guide/dev_details/static_data_files.rst @@ -22,23 +22,79 @@ over time and requires updates. Listed below are descriptions of some of the static data sources found in :code:`share/met`, along with recommended update frequency and method. +- Often updated *by developers* during development: + + - The :code:`config` directory contains all of the default configuration + files used by the MET tools. These are updated routinely when adding new + features and enhancements. + + - The :code:`python` and :code:`wrappers` directories contains Python + scripts to support the Python-embedding logic used throughout MET. + These are updated routinely when adding new features or enhancements + for Python-embedding. + + - :code:`table_files/met_header_columns_VX.Y.txt` files define + line types and column names for each **X.Y** released version of MET. + Stat-Analysis reads these files when processing the STAT output from + other MET tools. A new header file is added during development when + the software version number is increased. + +- Updated *by developers* prior to **each major X.Y release*: + - :code:`table_files/ndbc_stations.xml`, described in :numref:`User's Guide Section %s `, is read by ASCII2NC and contains buoy latitude and longitude locations that can - change on a daily basis. - To be used in real time, this file should be regenerated daily and the - :code:`MET_NDBC_STATION` environment variable should define its - current location. Since this static file is included with the code, - its contents should be updated **for each major X.Y release** using the - :code:`scripts/python/utility/build_ndbc_stations_from_web.py` utility. + change on a daily basis. To be used in real time, this file should be + regenerated daily and the :code:`MET_NDBC_STATION` environment variable + should define its location. Use the + :code:`scripts/python/utility/build_ndbc_stations_from_web.py` + utility to update the contents. - :code:`table_files/airnow_monitoring_site_locations_v2.txt`, described in :numref:`User's Guide Section %s `, - is read by ASCII2NC and contains AIRNOW site latitude and longitude - locations that can change over time. The :code:`MET_AIRNOW_STATIONS` - environment variable can be set to override its default location. - Since this static file is included with the code, its contents should - be updated **for each major X.Y release**. + is read by ASCII2NC, contains AIRNOW site latitude and longitude + locations that can change over time, and should be routinely updated. + The :code:`MET_AIRNOW_STATIONS` environment variable can be set to + override its default location. + + - :code:`table_files/grib*.txt` files define the GRIB1 and GRIB2 table + information. They are read by the MET libraries which read GRIB1 and + GRIB2 input data. Additions are made to these tables over time and + they should be routinely updated. The GRIB2 tables should be kept + current with those included in the **wgrib2** software, available at + https://github.com/NOAA-EMC/wgrib2. + + - :code:`tc_data/wwpts_us.txt` is read by TC-Pairs, contains hurricane + watch/warning information, and is referenced in the TC-Pairs + configuration file. Since hurricane watches and warnings change over + time, this file should be routinely updated. + + - :code:`data/map` is read by the MET tools which create PostScript + output plots. This data is derived from GIS shapefiles and defines + the background map data for plots. Since map data can change over + time, these files should be periodically updated using the + :code:`make_mapfiles` development utility. + +- Updated *by developers* only as needed: + + - :code:`table_files/stat_column_descriptions*.txt` is read by + Series-Analysis and contains descriptions of each statistic that are + written to the **long_name** attribute of the output variables. + This only needs to be updated when Series-Analysis is enhanced to + write new output statistic types. + + - :code:`tc_data/*land*` files are read be TC-DLand and/or TC-Pairs to + define the distance of storms to land. These definitions seldom change + over time and should only be modified when the TC-DLand tool is modified + to process the updated inputs. + + - :code:`climo/seeps/PPT24_seepsweights.nc` is read by Point-Stat when + computing the SEEPS line type as described in :numref:`User's Guide + Section %s `. This only needs to be updated when new SEEPS + stations are added or the 24-hour precipitation climatology values + are modified. + +- Updated *by users* only as needed: - :code:`table_files/obs_error_table.txt`, described in :numref:`User's Guide Section %s `, is read by @@ -47,35 +103,21 @@ recommended update frequency and method. override its default location. Generally, the observation error assumptions in this file do not change over time. Instead, it should be copied and modified by researchers for specific scientific - applications and use cases. + applications and use cases. - - :code:`table_files/grib*.txt` files define the GRIB1 and - GRIB2 table information. They are read by the MET libraries which - read GRIB1 and GRIB2 input data. Additions are made to these tables - over time and their contents should be reviewed and updated **for each - major X.Y** release. The GRIB2 tables should be kept current with those - provided with the **wgrib2** software, available at - https://github.com/NOAA-EMC/wgrib2. +- No updates typically required: - - :code:`table_files/met_header_columns_VX.Y.txt` files define - line types and column names for each **X.Y** released version of MET. - Stat-Analysis reads these files when processing the STAT output from - other MET tools. A new header file must be added **for each major X.Y - release**. + - :code:`colortables` is read by MET tools which write PostScript + output plots. While users are encouraged to copy and modify these + colortable files for their specific needs, these default colortables + do not change over time and typically require no updates. - - :code:`table_files/stat_column_descriptions*.txt` is read by - Series-Analysis and contains descriptions of each statistic that are - written to the **long_name** attribute of the output variables. - This only needs to be updated when Series-Analysis is enhanced to - write new output statistic types. + - :code:`poly` is read by the MET tools when applying polyline masking + regions. The default polyline regions included were originally + defined at NOAA/EMC, do not change over time, and typically require + no updates. - - :code:`tc_data/wwpts_us.txt` is read by TC-Pairs, contains hurricane - watch/warning information, and is referenced in the TC-Pairs - configuration file. Since hurricane watches and warnings change over - time, its contents should be updated **for each major X.Y release**. + - :code:`ps` is read by the MET tools which write PostScript output + plots. It contains the definintion of fonts that do not change over + time and typically require no updates. - - :code:`tc_data/*land*` files are read be TC-DLand and/or TC-Pairs to - define storms distance to land. These definitions seldom change over - time and should only be modified when the TC-DLand tool is modified - to process the updated inputs. -