Skip to content

Commit

Permalink
Some updates to the README documentation in responce to the split of …
Browse files Browse the repository at this point in the history
…cime out as well as the update to NUOPC as the default
  • Loading branch information
ekluzek committed Oct 6, 2021
1 parent 18c7517 commit 3c27967
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
30 changes: 13 additions & 17 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ $CTSMROOT/README 06/08/2018

Community Terrestrial Systems Model (CTSM) science version 5.1 series -- source code, tools,
offline-build and test scripts. This gives you everything you need
to run CTSM with CESM with datm8 to provide CRU NCEP or GSWP3 forcing data in
to run CTSM with CESM with the CMEPS driver and CDEPS data models to provide CRU NCEP or GSWP3 forcing data in
place of a modeled atmosphere.

For lists of current bugs (issues) and current development see the CTSM GitHub page:

https://github.com/ESCOMP/ctsm
https://github.com/ESCOMP/CTSM

IMPORTANT NOTE ON CESM CHECKOUT VERSUS A CTSM CHECKOUT:

Expand All @@ -28,29 +28,25 @@ General directory structure ($CTSMROOT):
doc --------------- Documentation of CTSM.
bld --------------- Template, configure and build-namelist scripts for clm.
src --------------- CTSM Source code.
lilac ------------- Lightweight Infrastructure for Land-Atmosphere Coupling (for coupling to a host atmosphere model)
test -------------- CTSM Testing scripts for CTSM offline tools.
tools ------------- CTSM Offline tools to prepare input datasets and process output.
cime_config ------- Configuration files of cime for compsets and CTSM settings
manage_externals -- Script to manage the external source directories
python ------------ Some python modules mostly for use by run_sys_tests (but could be used elsewhere)
python ------------ Some python modules mostly for use by run_sys_tests (but could be used elsewhere l

Directory structure only for a CTSM checkout:

components -------- Other active sub-components needed for CTSM to run (river routing and land-ice models)
libraries --------- CESM libraries: MCT and PIO
share ------------- CESM shared code

cime/scripts --------------- cesm/cime driver scripts

cime/src/drivers/mct/main ----------- CESM top level driver source code.
cime/src/drivers/mct/shr ------------ CESM top level driver shared code.
cime/src/components/data_comps/datm - CESM Data model version 8 source code.
cime/src/components/stub_comps/sice - CESM stub sea-ice model source code.
cime/src/components/stub_comps/socn - CESM stub ocean model source code.
cime/src/components/stub_comps/sglc - CESM stub glacier model source code.
cime/src/externals ------------------ CESM external utility codes
(Model Coupling Toolkit (MCT)
(Earth System Model Framework)
(timing -- code timing utility)
(pio -- Parallel Input/Output)
components/cmeps -------------------- CESM top level driver (for NUOPC driver) source code.
components/cdeps -------------------- CESM top level data model shared code (for NUOPC driver).
components/cpl7 --------------------- CESM top level driver for the MCT driver
cime/src/externals ------------------ CESM external utility codes (genf90)
components/cism --------------------- CESM Community land Ice Sheet Model.
components/mosart ------------------- Model for Scale Adaptive River Transport
components/rtm ---------------------- CESM River Transport Model.
Expand Down Expand Up @@ -92,7 +88,7 @@ run_sys_tests --------------- Python script to send the standard CTSM testing of

parse_cime.cs.status -------- Script to parse test status files cs.status.* created by create_test
(can be used along with run_sys_tests)
doc/Quickstart.GUIDE -------- Quick guide to using cpl7 scripts.
doc/Quickstart.GUIDE -------- Quick guide to using NUOPC scripts.
doc/IMPORTANT_NOTES --------- Some important notes about this version of
clm, configuration modes and namelist items
that are not validated or functional.
Expand Down Expand Up @@ -149,7 +145,7 @@ Source code directory structure:

src/biogeochem ---- Biogeochemisty
src/main ---------- Main control and high level code
src/cpl ----------- Land model high level MCT and ESMF drivers
src/cpl ----------- Land model high level caps for NUOPC driver (and MCT and LILAC)
src/biogeophys ---- Biogeophysics (Hydrology)
src/dyn_subgrid --- Dynamic land unit change
src/init_interp --- Online interpolation
Expand All @@ -161,7 +157,7 @@ src/unit_test_shr - Unit test shared modules for unit testing
src/unit_test_stubs Unit test stubs that replicate CTSM code simpler

=============================================================================================
QUICKSTART: using the CPL7 scripts
QUICKSTART: using the NUOPC driver scripts
=============================================================================================

cd $CIMEROOT/scripts
Expand Down
2 changes: 1 addition & 1 deletion README.CHECKLIST.new_case
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ General Checklist to always do:
- Make sure the LND_TUNING_MODE is correct
(./xmlquery LND_TUNING_MODE)
- For an "I compset" make sure you are running over the right forcing years
(usually ./xmlquery -p DATM_CLMNCEP_YR)
(usually ./xmlquery -p DATM_YR)
- First and align year for streams should be the start year of a historical simulation
(./xmlquery RUN_STARTDATE)
(grep stream_year_first CaseDocs/lnd_in; grep model_year_align CaseDocs/lnd_in)
Expand Down

0 comments on commit 3c27967

Please sign in to comment.