-
Notifications
You must be signed in to change notification settings - Fork 447
Closed
Labels
Area: CalcPertains to calculationsPertains to calculationsArea: DocsAffects documentationAffects documentationType: EnhancementEnhancement to existing functionalityEnhancement to existing functionality
Milestone
Description
What can be better?
In the documentation for the density function, the required arguments are listed as pressure, temperature, and mixing_ratio. However, in the note, the equation is written in terms of virtual temperature, which is inconsistent and maybe confusing. Perhaps the temperature argument could be defined as "Air temperature, or the virtual temperature if mixing_ratio is set to zero" to make things clearer. Or, mixing_ratio could be an optional argument I suppose (if missing, it's zero).
In my case, I already have virtual temperatures in my data, and do not have mixing ratio, so at first glance it seemed I might need to roll my own computation. (Admittedly, it's not the most complicated calculation to begin with!)
Metadata
Metadata
Assignees
Labels
Area: CalcPertains to calculationsPertains to calculationsArea: DocsAffects documentationAffects documentationType: EnhancementEnhancement to existing functionalityEnhancement to existing functionality