pytroll / pytroll/satpy

Introduce the newly chosen standard name

Open
#3,271 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.2k
Forks
335
Avg merge
1d 18h
Merged PRs (30d)
10

Description

As we have discussed in https://github.com/orgs/cf-convention/discussions/429, to be accurate, Satpy should not name quantities not normalised with the sun zenith angle as "toa_bidirectional_reflectance".

We thus need to introduce a new standard name in satpy for these quantities.
It might take while to get an official standard name in the cf conventions, so for now we are going to go for "oblique_toa_bidirectional_reflectance" "product_of_cosine_solar_zenith_angle_and_toa_bidirectional_reflectance", and use that until an official standard name is adopted.

Here are some of the to-do items we have identified so far.

  • Decide on something to use for now
  • Update base reader class to overwrite standard_name if “sunz_corrected” modifier is not present
  • Update enhancer to detect old standard name being matched and absence of “sunz_corrected” modifier and produce warning
  • Add satpy.config feature flag for pseudo-reflectance standard name to be False by default in 0.60, True in 1.0.
  • Copy all existing “toa_bidirectional_reflectance” enhancements with the new standard name for pseudo-reflectance since they are used interchangeably 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 with the linked discussion to resolve the temporary standard name, then inspect the base reader class, enhancer, satpy.config feature flag, and existing toa_bidirectional_reflectance enhancements. Done means pseudo-reflectance uses the chosen name, the old-name case warns appropriately, the flag has the requested defaults, and equivalent enhancements exist.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.