Update README to reflect current v2 repo state#427
Open
Conversation
Agent-Logs-Url: https://github.com/E3SM-Project/EKAT/sessions/aff84f20-e509-4dbc-ad39-f3c3122b7faf Co-authored-by: bartgol <3226046+bartgol@users.noreply.github.com>
Agent-Logs-Url: https://github.com/E3SM-Project/EKAT/sessions/aff84f20-e509-4dbc-ad39-f3c3122b7faf Co-authored-by: bartgol <3226046+bartgol@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README to reflect current repo state
Update README to reflect current v2 repo state
Apr 8, 2026
bartgol
approved these changes
Apr 8, 2026
bartgol
approved these changes
Apr 10, 2026
Contributor
bartgol
left a comment
bartgol
left a comment
There was a problem hiding this comment.
@jgfouca @jeff-cohere @tcclevenger feel free to add/modify the README. To me, it looks like a reasonable version.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The README was stale: wrong version, mentioned Fortran utilities that no longer exist, outdated cmake example (included
CMAKE_Fortran_COMPILER), and missing coverage of sub-packages and cmake utility scripts.Changes
Core,KokkosUtils,Pack,Algorithm,Expression,Logging,Parser) with CMake target names and 1-liner descriptions.EKAT_ENABLE_ALL_PACKAGES, no Fortran compiler); replaced bullet list of options with a structured table.EkatCreateUnitTest.cmake,EkatSetCompilerFlags.cmake,EkatUtils.cmake,EkatMpiUtils.cmake, and thetpls/fetch/build scripts.E3SM Stakeholder Feedback
N/A
Testing
Documentation-only change; no code paths affected.