ImperialCollegeLondon / ImperialCollegeLondon/virtual_ecosystem

Validation of `data_variables.toml` axis information

Open
#1,445 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Non-MVP
Dominant language
Python
Stars
20
Forks
5
Avg merge
2d 1h
Merged PRs (30d)
34

Description

From @arne-exe

The dimension(s) for each plant variable (including those required/populated/updated for update) should then also be shown in the variables table, as this is key to prepare (and interpret) the data. Currently the user is guessing what the dimension should be, which is problematic.

This is a good point. The information is actually already included in the table (though it could be presented in a more). The big issue is that the underlying axis information is not validated in any way and in many cases outdated.

Setting up proper validation is a significant task, so is definitely something we can only tackle post MVP (unless we decide it's something worth handing off to RCS)

This issue is mainly to track that this is an important problem, but not something we are going to address right now

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 reviewing data_variables.toml and the variables table to inventory the existing axis information and identify which entries are outdated or lack validation. Done means the underlying axis information is validated consistently for plant variables, including values required, populated, or updated for update.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.