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

Tempus: Remove Doxygen dependence on algpseudocode. #8845

Merged

Conversation

ccober6
Copy link
Contributor

@ccober6 ccober6 commented Mar 5, 2021

Need to remove our doxygen dependency on algpseudocode and algorithm
as not all systems have it installed, and therefore the doxygen
documentation was not available. Just used simple latex functionality
to reproduce the pseudo-algorithms.

  • Cleaned up documentation between Steppers and AppActions.
    • AppActions (Modifier, ModifierX and Observer) reference Stepper's
      pseudo-code.
  • Fix bugs int Leapfrog AppAction
    • Removed BEFORE_XDOT_UPDATE_INITIALIZE as it was not being used).
    • Added END_STEP.
  • Fixed some bugs in the doxygen
    • Miss use of algpseudocode.
    • doxygen confused ">>" used in templating (cahnged to "> >".
  • Removed tabs.

@trilinos/tempus

Need to remove our doxygen dependency on algpseudocode and algorithm
as not all systems have it installed, and therefore the doxygen
documentation was not available.  Just used simple latex functionality
to reproduce the pseudo-algorithms.

 * Cleaned up documentation between Steppers and AppActions.
   - AppActions (Modifier, ModifierX and Observer) reference Stepper's
     pseudo-code.
 * Fix bugs int Leapfrog AppAction
   - Removed BEFORE_XDOT_UPDATE_INITIALIZE as it was not being used).
   - Added END_STEP.
 * Fixed some bugs in the doxygen
   - Miss use of algpseudocode.
   - doxygen confused ">>" used in templating (cahnged to "> >".
 * Removed tabs.
@ccober6 ccober6 added impacting: documentation The issue is primarily about documentation vs. a problem with the build or tests pkg: Tempus labels Mar 5, 2021
@ccober6 ccober6 requested a review from sconde March 5, 2021 16:17
@ccober6 ccober6 self-assigned this Mar 5, 2021
@trilinos-autotester
Copy link
Contributor

Status Flag 'Pre-Test Inspection' - Auto Inspected - Inspection Is Not Necessary for this Pull Request.

@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - Failure: Timed out waiting for job Trilinos_pullrequest_cuda_10.1.105 to start: Total Wait = 603

@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - Failure: Timed out waiting for job Trilinos_pullrequest_cuda_10.1.105 to start: Total Wait = 603

@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - Failure: Timed out waiting for job Trilinos_pullrequest_cuda_10.1.105 to start: Total Wait = 603

@ccober6
Copy link
Contributor Author

ccober6 commented Mar 8, 2021

@trilinos/framework Not sure what the issue is here. These changes are primarily with doxygen, and I cannot login to https://ascic-jenkins.sandia.gov to determine the problem. Can you help?

@ccober6
Copy link
Contributor Author

ccober6 commented Mar 8, 2021

@rppawlo Since Sidafa is on vacation this week, can you review this for me?

@ccober6 ccober6 requested a review from rppawlo March 8, 2021 15:55
@ccober6 ccober6 added the AT: RETEST Causes the PR autotester to run a new round of PR tests on the next iteration label Mar 10, 2021
@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - User Requested Retest - Label AT: RETEST will be reset after testing.

@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: Trilinos_pullrequest_gcc_8.3.0

  • Build Num: 3885
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_gcc_7.2.0_serial

  • Build Num: 1446
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_gcc_7.2.0_debug

  • Build Num: 1934
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_intel_17.0.1

  • Build Num: 9279
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_cuda_10.1.105

  • Build Num: 731
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_clang_10.0.0

  • Build Num: 2093
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_python_3

  • Build Num: 4762
  • Status: STARTED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Using Repos:

Repo: TRILINOS (trilinos/Trilinos)
  • Branch: 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
  • SHA: c470f50
  • Mode: TEST_REPO

Pull Request Author: ccober6

@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: Trilinos_pullrequest_gcc_8.3.0

  • Build Num: 3885
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_gcc_7.2.0_serial

  • Build Num: 1446
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_gcc_7.2.0_debug

  • Build Num: 1934
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_intel_17.0.1

  • Build Num: 9279
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_cuda_10.1.105

  • Build Num: 731
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_clang_10.0.0

  • Build Num: 2093
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4

Build Information

Test Name: Trilinos_pullrequest_python_3

  • Build Num: 4762
  • Status: PASSED

Jenkins Parameters

Parameter Name Value
PR_LABELS AT: RETEST;impacting: documentation;pkg: Tempus
PULLREQUESTNUM 8845
TEST_REPO_ALIAS TRILINOS
TRILINOS_SOURCE_BRANCH 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode
TRILINOS_SOURCE_REPO https://github.com/trilinos/Trilinos
TRILINOS_SOURCE_SHA c470f50
TRILINOS_TARGET_BRANCH develop
TRILINOS_TARGET_REPO https://github.com/trilinos/Trilinos
TRILINOS_TARGET_SHA 0f69cc4


CDash Test Results for PR# 8845.

@trilinos-autotester trilinos-autotester removed the AT: RETEST Causes the PR autotester to run a new round of PR tests on the next iteration label Mar 11, 2021
@trilinos-autotester
Copy link
Contributor

Status Flag 'Pre-Merge Inspection' - SUCCESS: The last commit to this Pull Request has been INSPECTED AND APPROVED by [ rppawlo ]!

@trilinos-autotester
Copy link
Contributor

Status Flag 'Pull Request AutoTester' - AutoMerge IS ENABLED, but the Label AT: AUTOMERGE is not set. Either set Label AT: AUTOMERGE or manually merge the PR...

@ccober6 ccober6 merged commit a79ffe7 into develop Mar 11, 2021
@ccober6 ccober6 deleted the 8844-Tempus-Remove-Doxygen-dependence-on-algpseudocode branch March 5, 2024 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impacting: documentation The issue is primarily about documentation vs. a problem with the build or tests pkg: Tempus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants