Skip to content

sst.io

IO helpers for loading SST and ENSO data sets.

load_enso(path)

Load ENSO index observations from disk.

Parameters:

Name Type Description Default
path Path

File system location of a CSV file containing date and nino34 columns.

 required

Returns:

Type Description
DataFrame

Parsed ENSO index table with original column names and dtypes.
Source code in src/sst/io.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def load_enso(path: Path) -> pd.DataFrame:
    """Load ENSO index observations from disk.

    Parameters
    ----------
    path : pathlib.Path
        File system location of a CSV file containing ``date`` and ``nino34``
        columns.

    Returns
    -------
    pandas.DataFrame
        Parsed ENSO index table with original column names and dtypes.
    """
    return pd.read_csv(path)

load_sst(path)

Load sea surface temperature observations from disk.

Parameters:

Name Type Description Default
path Path

File system location of a CSV file containing date and sst_c columns.

 required

Returns:

Type Description
DataFrame

Parsed SST table with original column names and dtypes.
Source code in src/sst/io.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
def load_sst(path: Path) -> pd.DataFrame:
    """Load sea surface temperature observations from disk.

    Parameters
    ----------
    path : pathlib.Path
        File system location of a CSV file containing ``date`` and ``sst_c``
        columns.

    Returns
    -------
    pandas.DataFrame
        Parsed SST table with original column names and dtypes.
    """
    return pd.read_csv(path)