registry

data.registry

Canonical database registry — resolves short names to YAML file paths.

Works both from pip-installed packages and editable/dev installs. Searches recursively within each category directory so that models in subfolders (e.g. database/models/julia/) are automatically discovered. See TVBO-Database-Access-Proposal.md §5 for design rationale.

Functions

Name Description
database_dir Return the database directory for a given entity class.
list_entries List all available database entries for a class.
list_entries_with_metadata Return a list of dicts with name, model_type, description, path
resolve Resolve a short name to a database YAML file path.

database_dir

data.registry.database_dir(cls_name)

Return the database directory for a given entity class.

list_entries

data.registry.list_entries(cls_name)

List all available database entries for a class.

list_entries_with_metadata

data.registry.list_entries_with_metadata(cls_name)

Return a list of dicts with name, model_type, description, path for every entry in the given class category. Fast — reads only the first ~30 lines of each YAML file.

resolve

data.registry.resolve(cls_name, name)

Resolve a short name to a database YAML file path.

Tries exact top-level stem match first (fast path), then searches recursively by canonical name: field and file stem (case-insensitive). For Network, also matches BIDS filenames containing the atlas name.