Climate-REF/climate-ref

Add tooling to help build metric DataRequirements

Open

#27 opened on Nov 28, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (14 forks)auto 404
HackathonMetricsenhancementgood first issue

Repository metrics

Stars
 (25 stars)
PR merge metrics
 (PR metrics pending)

Description

The problem

As a metric developer, it may be hard to verify that the correct data requirements are being specified without running a metric. We should have some tooling to make that easier.

Perhaps with this debugging we might need to target a "fake" data catalog which is more consistent with the real world. Perhaps a subset of the Google CMIP6 data catalogue with some tweaks would be sufficient. I don't think it includes parent branching times etc, but we can either fake those or extract that info.

Definition of "done"

  • CLI entry to debug the data requirements of a single metric
  • Supports using a fake data catalog instead of the currently ingested datasets

Additional context

Contributor guide

Research direction
Investigate how to create a CLI command that prints data requirements for a given metric, and explore using a subset of CMIP6 data catalog with synthetic additions as a fake catalog.
Tech stack
python
Domain
backendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonCLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50