scipp / scipp/scitiff

Yaml file helper for metadata encoding.

Open
#68 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
2
Avg merge
9m
Merged PRs (30d)
1

Description

Currently you need to write all metadata programatically using pydantic models.
It can be quite cumbersome especially something that needs to be done repeatedly.
I would like to use yaml file to update/add metadata.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the pydantic models and the existing metadata encoding entry point. Determine how a YAML file should update or add metadata, then add coverage for the expected YAML-driven behavior. Done means metadata can be supplied repeatedly through a YAML file instead of being written programmatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, yaml
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.