Skip to content

atomref.registry

This module contains the packaged data model.

If you want to understand how atomref classifies datasets, how aliases are resolved, or how built-in CSV tables are turned into typed in-memory objects, this is the key module to read.

The most important registry ideas are:

  • quantity — the operational property family,
  • domain — the key space used to index that quantity,
  • dataset — one curated named table inside the quantity.

In the current runtime, the implemented lookup domain is element. The registry still stores domain explicitly because the metadata design is meant to stay reusable as the package grows.

atomref.registry

Dataset registry and packaged element-scalar set loading.

CoverageInfo dataclass

Coverage summary for an element-indexed scalar dataset.

DatasetInfo dataclass

Curated metadata for one packaged dataset.

This object keeps operational classification such as ref.quantity and usage_role separate from scientific classification such as semantic_class and phase_context.

DatasetRef dataclass

Stable reference to a packaged dataset.

The quantity identifies the operational property family, while set_id names a specific curated dataset within that family.

ElementScalarSet dataclass

Element-indexed scalar dataset stored densely by atomic number.

from_mapping(*, ref, values, name, units, description=None, usage_role='user', semantic_class='user', origin_class='user', phase_context=None, references=(), notes=(), placeholder_value=None) classmethod

Build a custom element-domain dataset from a symbol-keyed mapping.

get(symbol)

Return the scalar value for symbol or None if absent.

QuantityInfo dataclass

Metadata shared by all datasets that belong to one quantity.

Reference dataclass

Bibliographic record attached to packaged dataset metadata.

get_builtin_set(ref) cached

Load a packaged dataset as an :class:ElementScalarSet.

get_dataset_info(ref)

Return curated metadata for a packaged dataset reference.

get_quantity_info(quantity)

Return quantity-level metadata for a packaged quantity.

list_dataset_ids(quantity, *, usage_role=None)

List packaged dataset identifiers for a quantity.

When usage_role is provided, only datasets with a matching normalized role such as "target" or "support" are returned.

list_dataset_infos(quantity, *, usage_role=None)

Return packaged dataset metadata objects for a quantity.

list_quantities()

List packaged quantity identifiers in registry order.

resolve_dataset_like(dataset)

Resolve either a packaged reference or a custom set to a loaded set.