write

write(
    patch_or_spool ,
    path: str | pathlib._local.Path | upath.core.UPath[str, Path, UPath] ,
    file_format: str ,
    file_version: str | None[str, None] = None,
    split: bool = False,
    **kwargs ,
)-> ’_PathT’

Write a Patch or Spool to disk.

Parameters

Parameter	Description
patch_or_spool	The `Patch` or spool to write to disk.
path	The path to the file.
file_format	The string indicating the format to write.
file_version	Optionally specify the version of the file, else use the latest version for the format.
split	A written patch must have contiguous (non-gapped) coordinates. If True, patches whose dimensional coordinates contain gaps (segmented coordinates, e.g. from merging nearly-contiguous data) are split into contiguous patches before writing; this requires a format which supports multiple patches per file. If False (default) such patches raise a `ParameterError`.

Raises

UnknownFiberFormatError - Could not determine the fiber format.

Examples

from pathlib import Path
import dascore as dc

patch = dc.get_example_patch()
path = Path("output.h5")
_ = dc.write(patch, path, "dasdae")

assert path.exists()
path.unlink()