GeoEco.DataProducts.NOAA.ClimateIndices.PSLClimateIndices.FileToArcGISTable

classmethod PSLClimateIndices.FileToArcGISTable(path, table, field, overwriteExisting=False)

Creates and populates a table of climate index values parsed from a text file in NOAA PSL time series format.

Requires: ArcGIS Pro 3.2.0 or later or ArcGIS Server equivalent to ArcGIS Pro 3.2.0 or later.

Parameters:
  • path (str) –

    Text file containing data for one climate index, in the PSL time series format documented at https://psl.noaa.gov/data/climateindices/list/:

    year1 yearN
    year1 janval febval marval aprval mayval junval julval augval sepval octval decval
    year2 janval febval marval aprval mayval junval julval augval sepval octval decval
    ...
    yearN janval febval marval aprval mayval junval julval augval sepval octval decval
    missing_value
    

    For example, the North Atlantic Oscillation (NAO), available at https://psl.noaa.gov/data/correlation/nao.data, looked like this (circa 2007):

    1948 2007
    1948 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90
    1949 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90 -99.90
    1950   0.92   0.40  -0.36   0.73  -0.59  -0.06  -1.26  -0.05   0.25   0.85  -1.26  -1.02
    1951   0.08   0.70  -1.02  -0.22  -0.59  -1.64   1.37  -0.22  -1.36   1.87  -0.39   1.32
    <Lines deleted for brevity>
    2007   0.22  -0.47   1.44   0.17   0.66  -1.31  -0.58  -0.14   0.72 -99.90 -99.90 -99.90
      -99.9
     NAO Index from CPC
    https://psl.noaa.gov/data/climateindices/list/ for info
    

    Any lines following missing_value are treated as comments. Minimum length꞉ 1. Must exist.

  • table (str) –

    Table to create and populate. The table will have four fields:

    • IndexDate (DATE) - the date of the first day of the month and year of the climate index value (e.g. 1-March-1960).

    • IndexYear (LONG) - the year of the climate index value (e.g. 1990).

    • IndexMonth (LONG) - the month of the climate index value, ranging from 1 to 12.

    • Value (DOUBLE) - the index value for that month and year. The name of this field is specified by the Climate Index Value Field parameter, and need not be “Value”. If the output table is a dBASE table (a DBF file), the missing_value parsed from the input data will be used to represent “no data is available”. For other types of tables, a database NULL will represent “no data is available”.

    The second two fields store the same data as the first field but are present for your convenience, in case you prefer the year and month broken out as integers.

    The rows will be inserted in ascending date order and all 12 months will be included for every year. If these months occur in the future they will have the missing_value or NULL, as described above. Minimum length꞉ 1.

  • field (str) – Name of the field to receive the climate index value. Minimum length꞉ 1.

  • overwriteExisting (bool, optional) – If True, the output table will be overwritten, if it exists. If False, a ValueError will be raised if the output table exists.

Returns:

1. float: The value that means “no data is available” in the output table. If the output table is a dBASE table (a DBF file), the missing_value parsed from the input data will be returned. For other types of tables, None will be returned, representing a database NULL.

2. str: The comment parsed from the input data. If no comment was present, an empty string will be returned.

Return type:

tuple of 2 items