pardump

PARDUMP Reader. Deprecated wrapper — use monetio.load('pardump', ...) instead.

open_dataset(fname, drange=None, century=2000, verbose=False)

Read a HYSPLIT PARDUMP binary file.

Parameters:

Name	Type	Description	Default
fname	str	full path to pardump file	required
drange	list of two datetime objects	read in only particle positions between these two dates.	None
century	int	Only the last two digits of the year are stored in the pardump file. century must be specified (1900 or 2000) to read in the correct year.	2000
verbose	boolean		False

Returns:

Type	Description
DataFrame

Source code in monetio/models/pardump.py

@deprecated_wrapper(
    "monetio.models.pardump.open_dataset",
    'monetio.load("pardump", files=...)',
)
def open_dataset(fname, drange=None, century=2000, verbose=False):
    """Read a HYSPLIT PARDUMP binary file.

    Parameters
    ----------
    fname : str
        full path to pardump file
    drange : list of two datetime objects, optional
        read in only particle positions between these two dates.
    century : int, optional
        Only the last two digits of the year are stored in the pardump
        file. century must be specified (1900 or 2000) to read in the
        correct year.
    verbose : boolean, optional

    Returns
    -------
    pandas.DataFrame
    """
    return PardumpReader().open_dataset(
        files=fname,
        drange=drange,
        century=century,
        verbose=verbose,
        as_xarray=False,
    )