Skip to content

Update documentation including qc, debugger, and namelist table#459

Merged
apcraig merged 8 commits into
CICE-Consortium:masterfrom
apcraig:qcdoc
Jun 5, 2020
Merged

Update documentation including qc, debugger, and namelist table#459
apcraig merged 8 commits into
CICE-Consortium:masterfrom
apcraig:qcdoc

Conversation

@apcraig
Copy link
Copy Markdown
Contributor

@apcraig apcraig commented Jun 4, 2020

PR checklist

  • Short (1 sentence) summary of your PR:
    Update documentation including qc, debugger, and namelist table
  • Developer(s):
    apcraig
  • 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.
    Ran quick suites on cheyenne with 3 compilers, all bit-for-bit. Code changes are minimal.
    https://github.com/CICE-Consortium/Test-Results/wiki/cice_by_hash_forks#2054d0984a4a0eb1293e9fd3266bf3dbbd45753e
  • 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 Icepack 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/. A test build of the technical docs will be performed as part of the PR testing.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

Also added checks for ncat, nilyr, nslyr, nblyr and modified the abort flags implementation in ice_init converting from namelist to character string to be able to identify multiple failures with the abort_list variable.

Addresses issues #441, #412, #375, #347, #166 at least partly.

@apcraig
Copy link
Copy Markdown
Contributor Author

apcraig commented Jun 4, 2020

There are some obvious issues in the namelist tables. I'm working to fix them.

Copy link
Copy Markdown
Member

@phil-blain phil-blain left a comment

Choose a reason for hiding this comment

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

Looks good. I think both the abort changes and the updates to the doc are an imrpovement. Thanks!

@apcraig
Copy link
Copy Markdown
Contributor Author

apcraig commented Jun 4, 2020

OK, I think the table is fixed. I took it offline to debug and review. @eclare108213, let me know what you think.

Copy link
Copy Markdown
Contributor

@eclare108213 eclare108213 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 definitely an improvement, thank you. Just a couple of comments:

Under section 3.4.1, the second sentence copied below doesn’t make sense to me. Should there be additional wording, like "... in coupled configurations"?

Several of the variables defined in the file are not used in CICE. They exist to support the CICE model.

At the top of section 3.4.2, I suggest adding a sentence stating that the listed default value is assigned in the code if an option is not set (or not set correctly?) in the namelist input file, and is not necessarily the recommended value.

@apcraig
Copy link
Copy Markdown
Contributor Author

apcraig commented Jun 4, 2020

Thanks @eclare108213, I have update 3.4.1 and 3.4.2 as suggested and will merge in the next day unless there are other comments. I will work on the same changes in Icepack next.

@eclare108213
Copy link
Copy Markdown
Contributor

I just noticed that in the case settings table, kdyn=1 occurs twice. Please, would you remove the one that says "dynamics ON" and keep the one that says evp?

@apcraig
Copy link
Copy Markdown
Contributor Author

apcraig commented Jun 5, 2020

@eclare108213, I'm not seeing the kdyn issue. Are you looking at the latest table?

https://cice-consortium-cice--459.org.readthedocs.build/en/459/user_guide/ug_case_settings.html#dynamics-nml

@apcraig apcraig merged commit e49a405 into CICE-Consortium:master Jun 5, 2020
@eclare108213
Copy link
Copy Markdown
Contributor

I was looking at the docs on master. Looks like you already took care of it. Thanks!

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.

3 participants