Skip to content

Reference

These pages describe what datarecord does: what a record contains, what each call accepts, returns and refuses, and what is on disk.

A record and its data

What a record contains, and the calls that read, select and edit it.

  • The data model: dims, multi-dims, properties, categories, attributes and the broadcast rule.
  • The schema: every key a schema accepts, its dtypes, names and compatible changes.
  • The record: the RecordLike protocol, relations, flags and settle.
  • Selecting: select, squeezing, dropped labels and lift.
  • Editing: WorkingRecord, set, add, remove and edits.

Layers and storage

How revisions stack, how a read combines them, and what is on disk.

Tools and lookup

The tools that hand a record to a framework, and where to look up a word or a signature.

  • Tools: the tool's schema and the PyPSA tool.
  • Glossary: each project word and the page that defines it.
  • Python API: every public name, rendered from its docstring.