Module: Chemicalml::Dictionary

Defined in:: lib/chemicalml/dictionary.rb,
lib/chemicalml/dictionary/enum.rb,
lib/chemicalml/dictionary/link.rb,
lib/chemicalml/dictionary/entry.rb,
lib/chemicalml/dictionary/model.rb,
lib/chemicalml/dictionary/loader.rb,
lib/chemicalml/dictionary/registry.rb

Overview

Dictionary model layer. Canonical, format-agnostic representation of CML dictionaries (the dictionary, unit-dictionary, and unitType-dictionary conventions all share this shape).

Built-in dictionaries ship as YAML under data/dictionaries/ and are loaded into Chemicalml::Dictionary::Registry lazily.

Defined Under Namespace

Modules: Loader, Registry Classes: Entry, Enum, Link, Model

Constant Summary collapse

BUILTIN_DIR =

File.expand_path("../../data/dictionaries", __dir__).freeze

Class Method Summary collapse

.load(name) ⇒ Object
Convenience: load a built-in dictionary by short name (e.g. :compchem).

Class Method Details

.load(name) ⇒ `Object`

Convenience: load a built-in dictionary by short name (e.g. :compchem). Returns a Chemicalml::Dictionary::Model.



22
23
24

# File 'lib/chemicalml/dictionary.rb', line 22

def self.load(name)
  Registry.load_builtin(name)
end