NCAS-CMS / NCAS-CMS/cf-python

Tagging & filtering of example fields by characteristics & contexts

Open
#728 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

General feature idea

(As identified during a video call discussion yesterday with @davidhassell.) We now have 12 example fields all of which are distinguished by their numbering only, but they can be grouped according to notable characteristics and contexts, not all of which are across contiguous fields under this ordering due to the historical/practical order of addition to the examples, for instance:

  • DSG feature fields: 3, 4, 11;
  • UGRID mesh topologies: 8-10;
  • time series: 3, 4, 6;

etc. Whilst the documentation is good in that we have a table which provides a brief description of each numbered field which often mentions these, we agreed it would be useful to have a means to tag the fields with keywords describing such shared characteristics and contexts (and perhaps more e.g. for ones which have certain constructs such as cell methods) and, ideally, on top of this provide some means to filter on such keywords and on general metadata properties of the fields too.

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 the documentation table for the 12 numbered example fields and the current handling of field metadata. Define the desired tags and filtering behavior for shared characteristics, contexts, and general metadata properties; done requires an agreed design and an implemented way to apply and filter those tags.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
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.