Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document units of about 250 EOS variables #317

Merged
merged 2 commits into from
Feb 3, 2023

Conversation

Hallberg-NOAA
Copy link
Member

Added or amended comments to document the units of about 250 variables in 6 files in the src/equation_of_state directories. Also revised comments to make it clear that the MOM6 code for the UNESCO equation of state is based on the Jackett and MacDougall (1995) refit to the UNESCO equation of state (which uses potential temperature as a state variable) as opposed to the original UNESCO equation of state, as documented in an appendix to Gill (1982) (which uses in-situ temperature as a state variable). Also corrected a handful of spelling errors in comments. Only comments are changed, and all answers are bitwise identical.

@Hallberg-NOAA Hallberg-NOAA added the documentation Improvements or additions to documentation label Jan 29, 2023
@codecov
Copy link

codecov bot commented Jan 29, 2023

Codecov Report

Merging #317 (0903142) into dev/gfdl (454c5c6) will not change coverage.
The diff coverage is 0.00%.

@@            Coverage Diff            @@
##           dev/gfdl     #317   +/-   ##
=========================================
  Coverage     37.17%   37.17%           
=========================================
  Files           265      265           
  Lines         74424    74424           
  Branches      13822    13822           
=========================================
  Hits          27665    27665           
  Misses        41674    41674           
  Partials       5085     5085           
Impacted Files Coverage Δ
src/equation_of_state/MOM_EOS.F90 23.55% <ø> (ø)
src/equation_of_state/MOM_EOS_NEMO.F90 0.00% <0.00%> (ø)
src/equation_of_state/MOM_EOS_TEOS10.F90 0.00% <0.00%> (ø)
src/equation_of_state/MOM_EOS_UNESCO.F90 0.00% <0.00%> (ø)
src/equation_of_state/MOM_EOS_Wright.F90 35.66% <0.00%> (ø)
src/equation_of_state/MOM_EOS_linear.F90 20.94% <0.00%> (ø)
src/equation_of_state/MOM_TFreeze.F90 0.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

  Added or amended comments to document the units of about 250 variables in 6
files in the src/equation_of_state directories.  Also revised comments to make
it clear that the MOM6 code for the UNESCO equation of state is based on the
Jackett and MacDougall (1995) refit to the UNESCO equation of state (which uses
potential temperature as a state variable) as opposed to the original UNESCO
equation of state, as documented in an appendix to Gill (1982) (which uses
in-situ temperature as a state variable).  Also corrected a handful of spelling
errors in comments.  Only comments are changed, and all answers are bitwise
identical.
Copy link
Member

@marshallward marshallward left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an impressively detailed description of the EOS coefficients.

@marshallward
Copy link
Member

Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/18141 ✔️

@marshallward marshallward merged commit cab1e84 into NOAA-GFDL:dev/gfdl Feb 3, 2023
@Hallberg-NOAA Hallberg-NOAA deleted the document_EOS_units branch May 10, 2024 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants