Feat/provenance

[mandresm]

The Provenance feature PR!

Every value in config has now a provenance attribute. Many back-end features are added to provenance.

TODO

• [x] Add comments to finished_config (when yaml-dumping):

  fesom:
      branch: 2.5          # awicm3/awicm3.yaml, line: 342, col: 10, setup
      version: "2.5"       # fesom/fesom-2.5.yaml, line: 12, col: 8, component

• [x] Remove the folder ruamel-examples
• [x] Cleanup
• [x] Docstrings
• [x] Testing

@pgierz, you can use this branch to add this functionality. I have merged to this branch every Nadine's or your branches about the provenance and it's still working with the pytests and checkruns.

[mandresm]

And here the script for ruamel.yaml comments on the right of the values:

import ruamel.yaml
from io import StringIO

yaml = ruamel.yaml.YAML()  # defaults to round-trip

inp = {
    "abc": ["a"],
    "xyz": {
        "a": 1,
        "b": 2,
        "c": 3,
        "d": 4,
        "e": 5,
        "f": 6,
    }
}

# Use StringIO as a stream for dumping the YAML content
stream = StringIO()
yaml.dump(inp, stream)

# Load the YAML string back into a Python object
stream.seek(0)
data = yaml.load(stream)

print(type(data))

# Modify the data and add comments
data['abc'].append('b')
data['abc'].yaml_add_eol_comment('comment 4', 1)  # takes column of comment 1
data['xyz'].yaml_add_eol_comment('comment 5', 'c')  # takes column of comment 2
data['xyz'].yaml_add_eol_comment('comment 6', 'e')  # takes column of comment 3
data['xyz'].yaml_add_eol_comment('comment 7\n\n# that\'s all folks', 'd', column=20)

# Dump the modified data back to YAML
stream = StringIO()
yaml.dump(data, stream)

modified_yaml_str = stream.getvalue()
print(modified_yaml_str)

[mandresm]

Hi @pgierz, this is ready to be reviewed. Actual tests are passing in levante, the cleanup is done, docstrings written...

[mandresm]

Provenance documentation here:

https://esm-tools.readthedocs.io/en/feat-provenance/yaml_hierarchy.html#how-can-i-know-where-a-parameter-is-defined

[mandresm]

approve-changes

[mandresm]

bump