network_io

data.network_io

High-level Network I/O. Dispatches by companion file extension.

Supported companion formats

.h5 / .hdf5 — HDF5 (default, best compression) .zarr/ — Zarr (cloud-native, S3-compatible) .csv — CSV legacy (one file = one matrix = first template edge)

YAML sidecars are loaded via linkml_runtime.loaders.yaml_loader — the same loader used by Dynamics, Coupling, and SimulationExperiment. This ensures schema validation and proper nested object construction. Never use raw yaml.safe_load → cls(**dict) for LinkML classes.

See §12.2 of the tvbo HDF5 format proposal v0.7.

Functions

Name	Description
load_network	Load a tvbo Network from YAML/JSON sidecar + companion reference.
save_network	Save a tvbo Network as sidecar + binary companion.

load_network

data.network_io.load_network(yaml_path)

Load a tvbo Network from YAML/JSON sidecar + companion reference.

Uses linkml yaml_loader or json_loader to construct a schema-validated Network instance directly — same pattern as Dynamics.from_file().

Arrays are NOT loaded into memory. A LazyArrayStore is attached that loads arrays on first access (e.g., net.weights_matrix).

Parameters

yaml_path : str or Path Path to YAML or JSON sidecar file.

Returns

Network Fully constructed tvbo.Network with lazy array references.

save_network

data.network_io.save_network(
    network,
    yaml_path,
    binary_format='h5',
    sidecar_format='yaml',
)

Save a tvbo Network as sidecar + binary companion.

Uses LinkML yaml_dumper or json_dumper for schema-valid sidecar output — no manual field unpacking or yaml.dump() calls.

Parameters

network : Network Network instance to save. yaml_path : str or Path Output path for sidecar (extension overridden by sidecar_format). binary_format : str “h5” (default), “zarr”, or “csv”. sidecar_format : str “yaml” (default) or “json”.