Skip to content

Core

TableStore(path, mode='r', disk_format=DiskFormat.NONE, **kwargs)

Bases: Store, ABC

Abstract interface for tabular data.

kind = StoreKind.TABLE

query(path, ens_id=None, run_id=None, micro_id=None, filter_expr=None, **kwargs)

Query a named table using a filter expression.

PARAMETER DESCRIPTION

path

Container/table name.

TYPE: Path | str

ens_id

A unique identification label for an ensemble. This can be "1", "default", "exp3829", etc.

TYPE: str | None DEFAULT: None

run_id

An unique, independent run within the same ensemble. This often arises when running multiple independent molecular simulation trajectories with different random seeds.

TYPE: str | None DEFAULT: None

micro_id

An index specifying a microstate with some relationship to order. This can be a frame in a molecular simulation trajectories, docking scores from best to worst, optimization steps, etc.

TYPE: int | None DEFAULT: None

filter_expr

string expression to filter rows.

TYPE: str | None DEFAULT: None

RETURNS DESCRIPTION
Any

Filtered DataFrame.