API Reference¶

Generated from the docstrings. The docstrings cite the Design pages by link rather than restating the argument, so a symbol's "why" is one hop away; Usage is the worked prose.

Everything below is importable from the top-level package:

from datarecord import (
    AttributeSpec,
    Dimension,
    Directory,
    Flags,
    Frames,
    LazyFrames,
    NewChild,
    Record,
    RecordLike,
    Revision,
    Schema,
    WorkingRecord,
    connect,
    layer_dir,
    write_record,
)

page	symbols
Record	`Record`, `RecordLike`, `Frames`, `LazyFrames`, `Flags`
Schema	`Schema`, `Dimension`, `AttributeSpec`
Duck	`connect`, `layer_dir`
Layered	`Revision`, `write_record`
WorkingRecord	`WorkingRecord`, `NewChild`, `Directory`
Tools	`Tool`, `Requirements`, the PyPSA tool