PEtab-dev / PEtab-dev/PEtab

Specifying units

Open
#500 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement question specification change
Dominant language
No language data
Stars
66
Forks
16
Avg merge
3h 2m
Merged PRs (30d)
10

Description

Which problem would you like to address? Please describe.

It would be great if one could specify units for measurements (and potentially parameters) in PEtab in a systematic way. This would be quite valuable for reusing any measurement tables, would be helpful for creating axes labels for visualizations, and would allow for consistency checks.

Describe the solution you would like

Not sure what would be the best way. Maybe adding a measurementUnit field to the oberservables table? (Could additionally be specified for individual measurements to be used for conversion to the unit of the observable, but that is maybe too much.)

One would have to define a dictionary of supported units (which could become pretty long, see e.g. the ones used by pint)

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

No files, tests, or entry points are named. Start by reviewing the PEtab measurement and observables table specifications, then determine how observable and individual-measurement units and a supported-unit dictionary should be defined. Done means the unit representation, conversion rules, and consistency-check expectations are agreed and documented.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.