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 documentation for git-fleximod #2536

Closed
17 tasks done
samsrabin opened this issue May 9, 2024 · 3 comments · Fixed by #2559
Closed
17 tasks done

Update documentation for git-fleximod #2536

samsrabin opened this issue May 9, 2024 · 3 comments · Fixed by #2559
Assignees
@wwieder @slevis-lmwg
Labels
documentation additions or edits to user-facing documentation priority: high High priority to fix/merge soon, e.g., because it is a problem in important configurations
Milestone
cesm3_0_beta01 (u...

Comments

@samsrabin
Copy link
Collaborator

samsrabin commented May 9, 2024 •
edited by slevis-lmwg
Loading

Replace checkout_externals instructions with those for git-fleximod.

git grep -i 'checkout_ext'
returns the following list of files, though I have omitted here files from the /manage_externals directory that seem unnecessary in addressing the present issue:

  • Replace README_EXTERNALS.rst with new equivalent
  • bld/CLMBuildNamelist.pm
  • doc/README.CHECKLIST.master_tags
  • doc/build_docs
  • doc/design/python_script_user_interface.rst
  • doc/source/lilac/obtaining-building-and-running/obtaining-and-building-ctsm.rst
  • doc/source/lilac/specific-atm-models/wrf.rst
  • manage_externals/README.md and manage_externals/README_FIRST to be replaced with .lib/git-fleximod/README.md from Remove manage externals  #2443
  • python/ctsm/site_and_regional/run_neon.py
  • tools/mksurfdata_esmf/README.md

Some of the above is not documentation. There may exist other issues/PRs that address those files.
Rerun the git grep command later to confirm that I didn't miss something.

Definition of DONE:
@samsrabin samsrabin added priority: high High priority to fix/merge soon, e.g., because it is a problem in important configurations documentation additions or edits to user-facing documentation next this should get some attention in the next week or two. Normally each Thursday SE meeting. labels May 9, 2024
@wwieder wwieder mentioned this issue May 9, 2024
Closed
@samsrabin samsrabin removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label May 23, 2024
@samsrabin
Copy link
Collaborator Author

In a README file but also probably on the wiki.

@ekluzek ekluzek mentioned this issue May 29, 2024
Merged
@slevis-lmwg slevis-lmwg mentioned this issue May 29, 2024
Closed
@slevis-lmwg
Copy link
Contributor

@jedwards4b another TODO in this issue is to update the relevant documentation in the Wiki. Have you started working on that? Please let me know, because I was asked to work on it.

@jedwards4b
Copy link
Contributor

No, I'm not aware of a wiki

slevis-lmwg added a commit to chrislxj/ctsm that referenced this issue May 31, 2024
@slevis-lmwg
Merge tag 'ctsm5.2.007' into cn-matrix_v3
73031ae 
Rm manage_externals and update documentation accordingly

Fixes ESCOMP#2537 Remove manage_externals stuff from run_sys_tests
Fixes ESCOMP#2536 Update documentation for git-fleximod
Fixes ESCOMP#2467 Remove references to cheyenne from the testlist

slevis resolved conflicts:
bld/unit_testers/build-namelist_test.pl
cime_config/testdefs/ExpectedTestFails.xml
cime_config/testdefs/testlist_clm.xml
glemieux added a commit to samsrabin/CTSM that referenced this issue Jun 11, 2024
@glemieux
Merge tag 'ctsm5.2.007' into fates-landuse-v2
be4f999 
Rm manage_externals and update documentation accordingly

Fixes ESCOMP#2537 Remove manage_externals stuff from run_sys_tests
Fixes ESCOMP#2536 Update documentation for git-fleximod
Fixes ESCOMP#2467 Remove references to cheyenne from the testlist
slevis-lmwg added a commit to slevis-lmwg/ctsm that referenced this issue Jun 20, 2024
@slevis-lmwg
Merge tag 'ctsm5.2.007' into merge-b4bdev-20240620
a831a90 
Rm manage_externals and update documentation accordingly

Fixes ESCOMP#2537 Remove manage_externals stuff from run_sys_tests
Fixes ESCOMP#2536 Update documentation for git-fleximod
Fixes ESCOMP#2467 Remove references to cheyenne from the testlist

slevis resoloved conflicts:
cime_config/testdefs/ExpectedTestFails.xml
olyson added a commit to cathyxinchangli/CTSM that referenced this issue Jun 24, 2024
@olyson
Merge tag 'ctsm5.2.007' into explicit-hac-adoption
6896ab3 
Rm manage_externals and update documentation accordingly

Fixes ESCOMP#2537 Remove manage_externals stuff from run_sys_tests
Fixes ESCOMP#2536 Update documentation for git-fleximod
Fixes ESCOMP#2467 Remove references to cheyenne from the testlist
ekluzek added a commit to dmleung/CTSM that referenced this issue Jul 31, 2024
@ekluzek
Merge tag 'ctsm5.2.007' into dustemis_dev
93dc1f1 
Rm manage_externals and update documentation accordingly

Fixes ESCOMP#2537 Remove manage_externals stuff from run_sys_tests
Fixes ESCOMP#2536 Update documentation for git-fleximod
Fixes ESCOMP#2467 Remove references to cheyenne from the testlist

NOTE: Also
Add cam and cice to the .gitmodules file

 Conflicts:
	Externals.cfg
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wwieder wwieder

@slevis-lmwg slevis-lmwg

Labels
documentation additions or edits to user-facing documentation priority: high High priority to fix/merge soon, e.g., because it is a problem in important configurations
Projects
LMWG Near Term Priorities
Status: Done
Milestone
cesm3_0_beta01 (update to git fleximod)
4 participants
@jedwards4b @wwieder @samsrabin @slevis-lmwg