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.

Sign up for GitHub

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

Jump to bottom

Update lcov and env documentation #476

Merged
merged 2 commits into from
Jun 29, 2020
Merged

Update lcov and env documentation #476

merged 2 commits into from
Jun 29, 2020

Conversation

apcraig
Copy link
Contributor

@apcraig apcraig commented Jun 27, 2020

PR checklist

  • Short (1 sentence) summary of your PR:
    Update lcov again and update env documentation, both improvements and consistent with icepack
  • 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.
    No source code was changed
    lcov works, https://apcraig.github.io/
    quick suite with 3 compilers also works fine, https://github.com/CICE-Consortium/Test-Results/wiki/cice_by_hash_forks#884f70e3d579c3fd6f8fe7ef42fc4025962d4871
  • 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:

Consistency with improvements made in Icepack lcov and env documentation, namely moving the lcov env settings to the env files. Also updated the --env documentation.

phil-blain
phil-blain reviewed Jun 29, 2020
View reviewed changes
doc/source/user_guide/ug_running.rst
@@ -137,8 +135,7 @@ The **casescripts/** directory holds scripts used to create the case and can
largely be ignored. Once a case is created, the **cice.build** script should be run
interactively and then the case should be submitted by executing the
**cice.submit** script interactively. The **cice.submit** script
simply submits the **cice.run script**.
You can also submit the **cice.run** script on the command line.
Copy link
Member

Choose a reason for hiding this comment

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

I would not delete this last line. I often run tests and cases interactively on my workstation.

The rest looks good!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a reasonable point. I have add a sentence in this section to indicate the scripts can also be run interactively and submitted manually.

@apcraig apcraig merged commit c6c20bf into CICE-Consortium:master Jun 29, 2020
@apcraig apcraig deleted the lcov3 branch August 17, 2022 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phil-blain phil-blain phil-blain left review comments

@eclare108213 eclare108213 eclare108213 approved these changes

Assignees
No one assigned
Labels
Documentation Testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@apcraig @eclare108213 @phil-blain