NCAS-CMS / NCAS-CMS/cf-python

New recipe to outline, or dedicated method for, attaching orography

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

Nobody has claimed this yet.

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

Description

A fairly common operation for users of cf, and one we know we will need for TWINE-VISION project purposes, is to read in a dataset defining orography and attach it to some other field to define the orography context for the information encapsulated by the field.

As clarified by @davidhassell today, this can be achieved with a three-step process involving reading in the separate orography, converting it from a read-in field to a domain ancillary, and finally attaching it to the other field. (One minor complication is that the X and Y coordinates need to be identified so they are assigned in the right order during the conversion to the domain ancillary, but that is about all that could go wrong.)

Given that users will often want to perform this, it would be nice to make it simpler for them than this, either by:

  • having a dedicated method which will do the three steps in one to make the attachment, called something natural like attach_orogaphy or similar; or
  • adding a new recipe to our documentation to outline how the attachment can be done, with descriptions of the steps.

It's not yet clear to me which is best, so I will leave that as an open question/decision for future.

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 existing three-step workflow described in the issue: read the orography, convert it to a domain ancillary, and attach it to the target field. Resolve whether this should be a dedicated method or a documentation recipe, including how X and Y coordinates are identified. Done means users have a clear, supported way to attach a separate orography dataset.

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.