diff --git a/echemdb/data/cv/entry.py b/echemdb/data/cv/entry.py index 5f5a02d71..b2df1b0de 100644 --- a/echemdb/data/cv/entry.py +++ b/echemdb/data/cv/entry.py @@ -68,7 +68,7 @@ def __dir__(self): >>> entry = Entry.create_examples()[0] >>> dir(entry) - ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattr__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_descriptor', 'create_examples', 'curator', 'df', 'electrochemical_system', 'figure_description', 'identifier', 'package', 'plot', 'profile', 'resources', 'source'] + ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattr__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_descriptor', 'create_examples', 'curator', 'df', 'electrochemical_system', 'figure_description', 'identifier', 'package', 'plot', 'profile', 'resources', 'source', 'yaml'] """ return list(set(dir(Descriptor(self.package.descriptor)) + object.__dir__(self))) @@ -297,3 +297,17 @@ def __repr__(self): """ return repr(self._descriptor) + + @property + def yaml(self): + r'''Return a printable representation of this descriptor in yaml format. + + EXAMPLES:: + + >>> descriptor = Descriptor({'a': 0}) + >>> descriptor.yaml + 'a: 0\n' + + ''' + import yaml + return yaml.dump(self._descriptor) diff --git a/environment.yml b/environment.yml index 8529f3e6e..d786eccf0 100644 --- a/environment.yml +++ b/environment.yml @@ -12,6 +12,7 @@ dependencies: - plotly - pip - pytest + - pyyaml - pip: - linkchecker - mkdocs-material diff --git a/templates/cv_entry.md b/templates/cv_entry.md index ea4d250be..700c6492a 100644 --- a/templates/cv_entry.md +++ b/templates/cv_entry.md @@ -27,18 +27,15 @@ Properties of the electrochemical cell: * Reference electrode: XXX +## Metdata +
+Click to expand metadata (yaml). + +```yaml +{{ entry.electrochemical_system.yaml }} +``` +
---- - - -## electrolyte -0.1 M CsF + 0.1 M HClO4 - -## reference electrode - -{{ entry.electrochemical_system.electrodes.reference_electrode.type }} - -## scan rate -{{ entry.figure_description.scan_rate.value }} {{ entry.figure_description.scan_rate.unit | lower }}