Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

How best to handle the default (Earth) radius constant

Aperta
  • Qualcosa non va?
#941 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
data

Direzione di ricerca

Inizia da cf/constants.py e mixin/fielddomain.py, quindi esamina il valore predefinito del raggio in cf.relative_vorticity e la convenzione esistente di Field.cell_area. Individua gli altri riferimenti al raggio che usano il valore del raggio terrestre e confrontane i nomi e i valori predefiniti. Il lavoro è completo quando il valore predefinito è centralizzato e i riferimenti interessati supportano in modo coerente il comportamento descritto per il raggio terrestre.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

code tidy enhancement question

Throughout the codebase we often perform calculations using a value for the radius of a sphere. This can usually be assumed to be the Earth's because the relevant calculations concern the Earth's surface - but there may also be applications to extra-planetary atmospheres and oceans etc. so when referencing/naming the radius generally we should keep that wider scope in mind so as to not to possibly put off those wanting to do calculations for other planets.

During code review for #910 we decided to have a think about how best to handle the Earth radius default as a value that has a default to sensible precision (we use 6371229.0 meters generally), including as hard-coded at present as:

  • in mixin/fielddomain.py as a float constant (potnetially not ideal as a float as technically that can vary very slightly by floating point precision, as a separate concern);
  • a radius kwarg value default for cf.relative_vorticity.

See thread in https://github.com/NCAS-CMS/cf-python/pull/910#discussion_r2967106221 for original discussion points.

Suggestion

I suggest that:

  • we add earth_radius[_value] to the constants module as an integer value 6371229 and import there where necessary. The canonical units for it are already defined there:

    https://github.com/NCAS-CMS/cf-python/blob/8c760f82ed119cdda0ad041bc9deec49f3bc15d4/cf/constants.py#L18

    so it is nice to have it close to those as an additional benefit;

  • we change any radius reference to make sure it doesn't reference the 'Earth' in the name explicitly, but take our default Earth radius as default (the average user will be considering the Earth and surely in most cases not need to tweak the value from default precision);

  • for any functions that use the default Earth radius, consult that constant - notably where there's a corresponding keyword argument radius take 'earth' as a string default to mean 'use the default earth value', as we presently do for many methods such as Field.cell_area.

Lingua principale
Python
Stelle
151
Fork
23
Merge medio
1g 2h
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NCAS-CMS/cf-python

Tutte le issue di NCAS-CMS/cf-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.