Arrays and storage

as_scale_array

as_scale_array(
    data: Any,
    x: NestedScale,
    value: str | None = None,
    frames: Sequence[str] | str | None = None,
    fill: float = np.nan,
    limit: float = 10000000.0,
) -> np.ndarray

A dense numpy array over the units of one frame (default: atoms).

as_scale_table

as_scale_table(
    a: Any,
    x: NestedScale,
    value: str = "value",
    frames: Sequence[str] | str | None = None,
    drop_na: bool = True,
) -> pa.Table

The long table of a dense array over one frame's units.

write_scale_dataset

write_scale_dataset(
    data: Any,
    x: NestedScale | ScaleProduct,
    path: str | Path,
    partitioning: str | Sequence[str] | None = None,
    compression: str = "zstd",
    overwrite: bool = False,
) -> Path

Write data and the scales that index it to one folder.

open_scale_dataset

open_scale_dataset(path: str | Path) -> ScaleDataset

Open a folder written by write_scale_dataset() (from R or Python).

scale_dataset_info

scale_dataset_info(path: str | Path) -> dict[str, Any]

Describe a stored dataset without opening it: kind, axes, keys, files, bytes.