Add a terminology page to docs for "translating" between CF and xarray terminology

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reviewing xarray's Terminology page and the existing cf-xarray documentation structure. Add a terminology translation page covering differences such as xarray's dimension and non-dimension coordinates versus CF's coordinate and auxiliary coordinate variables.

Written by the indexing model from the issue text.

Description

documentation help wanted

xarray itself has a very helpful Terminology page that gives definitions for the key objects/concepts in xarray. As that page notes, these differ somewhat from CF. Since cf-xarray further acts to bridge the gap between xarray and the CF conventions, it may be helpful to have a sort of "terminology translation" page to the cf-xarray docs to alleviate confusion. For example: xarray uses "dimension coordinate" and "non-dimension coordinate" whereas CF uses "coordinate variable" and "auxiliary coordinate variable".

Dominant language
Python
Stars
181
Forks
49
Avg merge
43m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

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.

More from xarray-contrib/cf-xarray

All issues in xarray-contrib/cf-xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.