specific contents jargon clarifications (to avoid humidity of snow, ice, rain, ...) #3760
Conversation
|
Warning You have reached your daily quota limit. As a reminder, free tier users are limited to 5 requests per day. Please wait up to 24 hours and I will start processing your requests again! |
WalkthroughThe pull request updates terminology related to moisture variables across both documentation and source code. References to “specific humidity” have been replaced with “total water specific content” or “specific content” in variable descriptions, inline comments, and function documentation. These changes span markdown documentation files and various source modules, ensuring consistency in naming without modifying the underlying equations or logic. Changes
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/src/equations.md (3)
394-395: Consider using hyphenated form "precipitation-specific content".When "specific" is used as a modifier after another noun, it's typically hyphenated.
-where ``q_p``, ``\boldsymbol{u}``, ``v_p``, ``c_p `` are the precipitation specific content, +where ``q_p``, ``\boldsymbol{u}``, ``v_p``, ``c_p`` are the precipitation-specific content,🧰 Tools
🪛 LanguageTool
[uncategorized] ~394-~394: When ‘precipitation-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...dsymbol{u},v_p,c_p `` are the precipitation specific content, air velocity, precipitation te...(SPECIFIC_HYPHEN)
🪛 markdownlint-cli2 (0.17.2)
394-394: Spaces inside code span elements
null(MD038, no-space-in-code)
405-406: Consider using hyphenated form "tracer-specific content".Similar to the previous comment, the hyphenated form is typically used when "specific" is used as a modifier.
- available tracer specific content divided by a coefficient ``a``. + available tracer-specific content divided by a coefficient ``a``.🧰 Tools
🪛 LanguageTool
[uncategorized] ~405-~405: When ‘tracer-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... that they don't exceed the available tracer specific content divided by a coefficienta....(SPECIFIC_HYPHEN)
🪛 markdownlint-cli2 (0.17.2)
406-406: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
412-414: Add commas around the transitional word "however".For better readability and proper punctuation, the word "however" should be set off with commas.
-It should however help mitigate some of the problems. +It should, however, help mitigate some of the problems.🧰 Tools
🪛 LanguageTool
[typographical] ~412-~412: Consider adding two commas here.
Context: ... solution to negative numbers. It should however help mitigate some of the problems. The...(HOWEVER_COMMA)
docs/src/diagnostic_edmf_equations.md (1)
25-25: Consider using "subdomain" (one word) instead of "sub-domain".For consistency with common usage in computational science, "subdomain" is typically written as a single word without a hyphen.
-* ``q_t^j``: total water specific content of the sub-domain j, discretized at cell centers. +* ``q_t^j``: total water specific content of the subdomain j, discretized at cell centers.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...discretized at cell centers. *q_t^j: total water specific content of the sub...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: When ‘water-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...zed at cell centers. *q_t^j: total water specific content of the sub-domain j, discretize...(SPECIFIC_HYPHEN)
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...: total water specific content of the sub-domain j, discretized at cell centers. *u^{...(EN_COMPOUNDS_SUB_DOMAIN)
src/diagnostics/core_diagnostics.jl (1)
483-484: TODO comments added for future variable naming standardization.The TODO comments appropriately flag that both the long name and standard name for the "hussfc" variable should be updated in the future for consistency with the new terminology. However, there's a typo in the comment ("Spefici" instead of "Specific").
- long_name = "Surface Specific Humidity", # TODO: rename to "Surface Total Water Spefici Content" + long_name = "Surface Specific Humidity", # TODO: rename to "Surface Total Water Specific Content"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
docs/src/diagnostic_edmf_equations.md(3 hunks)docs/src/edmf_equations.md(1 hunks)docs/src/equations.md(3 hunks)src/cache/cloud_fraction.jl(4 hunks)src/cache/precomputed_quantities.jl(2 hunks)src/diagnostics/core_diagnostics.jl(7 hunks)src/initial_conditions/initial_conditions.jl(1 hunks)src/parameterized_tendencies/microphysics/microphysics_wrappers.jl(4 hunks)src/prognostic_equations/edmfx_sgs_flux.jl(4 hunks)src/prognostic_equations/forcing/external_forcing.jl(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/edmf_equations.md
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ... at cell centers. * \hat{\rho}^j q^j: moisture tracers. q^j stands for th...
(UNLIKELY_OPENING_PUNCTUATION)
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...oisture tracers. q^j stands for the sub-domain total condensate (liquid, ice, rain, sn...
(EN_COMPOUNDS_SUB_DOMAIN)
docs/src/equations.md
[uncategorized] ~394-~394: When ‘precipitation-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...dsymbol{u}, v_p, c_p `` are the precipitation specific content, air velocity, precipitation te...
(SPECIFIC_HYPHEN)
[uncategorized] ~405-~405: When ‘tracer-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... that they don't exceed the available tracer specific content divided by a coefficient a....
(SPECIFIC_HYPHEN)
[typographical] ~412-~412: Consider adding two commas here.
Context: ... solution to negative numbers. It should however help mitigate some of the problems. The...
(HOWEVER_COMMA)
docs/src/diagnostic_edmf_equations.md
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ..., discretized at cell centers. * q_t: total water specific content in kg/kg, ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: When ‘water-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...tized at cell centers. * q_t: total water specific content in kg/kg, discretized at cell c...
(SPECIFIC_HYPHEN)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...discretized at cell centers. * q_t^j: total water specific content of the sub...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: When ‘water-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...zed at cell centers. * q_t^j: total water specific content of the sub-domain j, discretize...
(SPECIFIC_HYPHEN)
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...: total water specific content of the sub-domain j, discretized at cell centers. * u^{...
(EN_COMPOUNDS_SUB_DOMAIN)
🪛 markdownlint-cli2 (0.17.2)
docs/src/equations.md
394-394: Spaces inside code span elements
null
(MD038, no-space-in-code)
406-406: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: ci 1.11 - windows-latest
- GitHub Check: ci 1.11 - macOS-latest
- GitHub Check: ci 1.11 - ubuntu-latest
- GitHub Check: ci 1.10 - windows-latest
- GitHub Check: downstream ClimaCoupler.jl (1.11)
- GitHub Check: test (1.11)
- GitHub Check: ci 1.10 - macOS-latest
- GitHub Check: evaluate
- GitHub Check: downstream ClimaCoupler.jl (1.10)
- GitHub Check: test (1.10)
- GitHub Check: ci 1.10 - ubuntu-latest
- GitHub Check: docbuild
- GitHub Check: format
🔇 Additional comments (29)
src/initial_conditions/initial_conditions.jl (1)
356-356: Appropriate terminology update.This change updates the parameter description from "humidity" to "specific humidity," better specifying the physical quantity being referred to. This aligns with the PR's goal of clarifying humidity-related terminology.
docs/src/edmf_equations.md (1)
25-25: Improved scientific precision in terminology.The update from "specific humidity" to "total condensate (liquid, ice, rain, snow) specific content" provides a more accurate description of the variable
q^j. This change helps distinguish between water vapor (humidity) and total water content including condensed phases.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ... at cell centers. *\hat{\rho}^j q^j: moisture tracers.q^jstands for th...(UNLIKELY_OPENING_PUNCTUATION)
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...oisture tracers.q^jstands for the sub-domain total condensate (liquid, ice, rain, sn...(EN_COMPOUNDS_SUB_DOMAIN)
src/prognostic_equations/forcing/external_forcing.jl (2)
213-213: Consistent terminology update.Changed comment from "total specific humidity" to "total water specific content" to be more precise about the variable's nature, consistent with the PR's objective of standardizing water content terminology.
297-297: Consistent terminology update.Changed comment from "total specific humidity" to "total water specific content" to maintain consistent terminology throughout the codebase.
src/cache/cloud_fraction.jl (4)
52-52: Added TODO for terminology consistency.The comment now includes a TODO to rename the function from "total_specific_humidity" to "total_water_specific_content", flagging it for future code changes while maintaining the current functionality.
98-98: Added consistent TODO for terminology update.This matches the previous TODO comment, ensuring consistent terminology updates throughout the file.
268-268: Consistent terminology update with TODO.Added a similar TODO comment for renaming "total_specific_humidity" to "total_water_specific_content", maintaining consistency with other similar changes in the file.
328-328: Updated variable description for clarity.Changed the description of
qfrom "total water specific humidity" to "total water specific content", providing more precise terminology for this variable in the function documentation.src/parameterized_tendencies/microphysics/microphysics_wrappers.jl (6)
42-42: Improved physical description.Updated parameter description from "liquid water specific humidity" to "liquid water specific content" for better scientific precision. This change correctly identifies that liquid water is not humidity (which typically refers to water vapor).
113-113: Consistent terminology update.Changed "total water specific humidity" to "total water specific content" to maintain consistent terminology across the codebase for water content variables.
151-151: Terminology update for consistency.Updated the description of precipitation variables from "specific humidity" to "specific content", correctly reflecting that precipitation (rain and snow) are condensed water phases, not vapor.
157-157: Improved accuracy in source term description.Changed "specific humidity source terms" to "water specific content source terms" to better describe what these quantities represent physically.
275-275: Consistent terminology update.Changed from "specific humidities" to "specific contents" to maintain consistency with other terminology changes throughout the PR.
281-281: Scientific accuracy improvement.Updated source term description from "specific humidity source terms" to "water specific content source terms" for better physical accuracy, consistent with the PR's goal of clarifying water-related terminology.
docs/src/equations.md (1)
286-287: Terminology updated correctly to align with PR objectives.The change from "specific humidity" to "specific content" for precipitation variables is appropriate and consistent with the PR's goal of reserving "humidity" for actual humidity measurements while using more precise terms for other forms of water content.
docs/src/diagnostic_edmf_equations.md (2)
11-11: Terminology updated correctly to align with PR objectives.The change from "total specific humidity" to "total water specific content" for the variable
q_tis consistent with the PR's goal of standardizing terminology related to water content.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ..., discretized at cell centers. *q_t: total water specific content in kg/kg, ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: When ‘water-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...tized at cell centers. *q_t: total water specific content in kg/kg, discretized at cell c...(SPECIFIC_HYPHEN)
25-25: Terminology updated correctly to align with PR objectives.The change from "total specific humidity" to "total water specific content" for the subdomain variable
q_t^jmaintains terminology consistency throughout the documentation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...discretized at cell centers. *q_t^j: total water specific content of the sub...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: When ‘water-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...zed at cell centers. *q_t^j: total water specific content of the sub-domain j, discretize...(SPECIFIC_HYPHEN)
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...: total water specific content of the sub-domain j, discretized at cell centers. *u^{...(EN_COMPOUNDS_SUB_DOMAIN)
src/prognostic_equations/edmfx_sgs_flux.jl (3)
59-59: Terminology updated correctly in comments.The comment has been updated from "specific humidity" to "total water specific content", which aligns with the PR's standardization objectives.
236-236: Terminology updated correctly in comments.The comment has been consistently updated to use "total water specific content" instead of "specific humidity".
408-408: Terminology updated correctly in comments.The comment has been consistently updated to use "total water specific content", maintaining terminology consistency throughout the codebase.
src/cache/precomputed_quantities.jl (2)
31-31: Terminology updated correctly in precomputed quantities documentation.The documentation for
ᶜq_tot⁰has been updated to use "total water specific content" instead of "total specific humidity", consistent with the PR objectives.
518-519: TODO comment added for future function renaming.The TODO comment appropriately indicates that the function name
total_specific_humidityshould be renamed tototal_water_specific_contentin a future update, maintaining consistency with the current terminology changes.src/diagnostics/core_diagnostics.jl (7)
348-349: Terminology updated correctly in diagnostic variable documentation.The section header has been updated to use "Total water specific content (3d)" instead of "Total specific humidity (3d)", consistent with the PR objectives.
372-373: TODO comments added for future variable naming standardization.The TODO comments appropriately flag that both the long name and standard name for the "hus" variable should be updated in the future for consistency with the new terminology.
380-380: Terminology updated correctly in diagnostic variable documentation.The section header has been updated to use "Liquid water specific content (3d)" instead of "Liquid water specific humidity (3d)".
416-416: Terminology updated correctly in diagnostic variable documentation.The section header has been updated to use "Ice water specific content (3d)" instead of "Ice water specific humidity (3d)".
452-452: Terminology updated correctly in diagnostic variable documentation.The section header has been updated to use "Surface total water specific content (2d)" instead of "Surface specific humidity (2d)".
468-468: TODO comments added for future function renaming.The TODO comments appropriately indicate that the function name
total_specific_humidityshould be renamed tototal_water_specific_contentfor consistency.Also applies to: 474-474
1242-1242: Clear TODO comment for potential renaming consideration.The comment appropriately flags a question about whether "Vapor Specific Humidity" should be renamed to simply "Specific Humidity", which would make sense if we're reserving the term "humidity" specifically for vapor-phase water.
Purpose
Avoid misleading jargon featuring humidities of snow, humidities of water, etc by reserving the term "humidity" for humidity, and using specific contents for all other solid and liquid phase per-mass water contents. See related CliMA/CloudMicrophysics.jl#540
To-do
Content
jargon changes in docs and code comments
Summary by CodeRabbit