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

doc: mention code variables relating to 'calc_dragio' #466

Merged
merged 2 commits into from
Oct 11, 2023

Conversation

phil-blain
Copy link
Member

PR checklist

  • Short (1 sentence) summary of your PR:
    title
  • Developer(s):
    me
  • Suggest PR reviewers from list in the column to the right.
  • Please copy the PR test results link or provide a summary of testing completed below.
    doc only - no tests.
  • How much do the PR code changes differ from the unmodified code?
    • bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on CICE or any other models?
    • Yes
    • No
  • Does this PR add any new test cases?
    • Yes
    • No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

At the end of the "Ocean" section, we mention that 'dragio' can be computed from 'iceruf_ocn' and 'thickness_ocn_layer1', but do not mention these code variables, nor the 'calc_dragio' setting used to activate that computation. Mention the code variables next to their mathematical symbol, for more clarity.

Closes #463

@phil-blain
Copy link
Member Author

I added the readthedocs config file, it seems it is now required (I copied the one from CICE).

@apcraig
Copy link
Contributor

apcraig commented Oct 11, 2023

@phil-blain, thanks for adding the yml file. This was working last week, not sure why it's suddenly not. I probably had a plan to fix this in Icepack when I updated the CICE yml and that task got lost on the list. Odd that it was working fine in Icepack until this week. Anyway, thanks.

I will leave it to others to comment on the documentation changes.

Copy CICE's readthedocs configuration as of
CICE-Consortium/CICE@06282a53 (Update version to 6.4.2 (#864),
2023-09-08).
At the end of the "Ocean" section, we mention that 'dragio' can be
computed from 'iceruf_ocn' and 'thickness_ocn_layer1', but do not
mention these code variables, nor the 'calc_dragio' setting used to
activate that computation. Mention the code variables next to their
mathematical symbol, for more clarity.
@eclare108213 eclare108213 merged commit 45da0b3 into CICE-Consortium:main Oct 11, 2023
1 check passed
@phil-blain phil-blain deleted the calc-dragio-doc branch January 24, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

calc_dragio functionality
3 participants