Skip to content

hytraj

HYTRAJ Reader. Deprecated wrapper — use monetio.load('hytraj', ...) instead.

combine_dataset(flist, taglist=None, renumber=False, verbose=False)

Opens multiple tdump files. returns Pandas DataFrame

Parameters:

Name Type Description Default
flist list

filenames

 required
taglist list

differentiate trajectories by adding extra pid column with this value.

 None
renumber bool

renumber the trajectories so all trajectories have unique number.

 False
verbose bool

print verbose output.

 False

Returns:

Type Description
DataFrame
Source code in monetio/models/hytraj.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@deprecated_wrapper(
    "monetio.models.hytraj.combine_dataset",
    'monetio.load("hytraj", files=...)',
)
def combine_dataset(flist, taglist=None, renumber=False, verbose=False):
    """Opens multiple tdump files. returns Pandas DataFrame

    Parameters
    ----------
    flist : list
        filenames
    taglist : list, optional
        differentiate trajectories by adding extra pid column with this value.
    renumber : bool, optional
        renumber the trajectories so all trajectories have unique number.
    verbose : bool, optional
        print verbose output.

    Returns
    -------
    pandas.DataFrame
    """
    return HYTRAJReader().open_dataset(
        files=flist,
        taglist=taglist,
        renumber=renumber,
        as_xarray=False,
    )

open_dataset(filename)

Opens a tdump file, returns trajectory array

Parameters:

Name Type Description Default
filename string

Full file path for tdump file

 required

Returns:

Type Description
DataFrame

DataFrame with all trajectory information
Source code in monetio/models/hytraj.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@deprecated_wrapper(
    "monetio.models.hytraj.open_dataset",
    'monetio.load("hytraj", files=...)',
)
def open_dataset(filename):
    """Opens a tdump file, returns trajectory array

    Parameters
    ----------
    filename : string
        Full file path for tdump file

    Returns
    -------
    pandas.DataFrame
        DataFrame with all trajectory information
    """
    return HYTRAJReader().open_dataset(files=filename, as_xarray=False)