diff --git a/ChangeLog b/ChangeLog index 084f082a5b..5e6b4c570f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,120 @@ +=============================================================== +Tag name: cesm2.2.1-rc.01 +Originator(s): CSEG +Date: 4th April 2023 +One-line Summary: cesm2.2.1 release. + + +Component tags used for this CESM release candidate tag : + +components/cam https://github.com/ESCOMP/CAM/tree/cam_cesm2_2_rel_07 +components/cice https://github.com/ESCOMP/CESM_CICE5/tree/cice5_20200430 +cime https://github.com/ESMCI/cime/tree/cime5.8.32.1 +components/cism https://github.com/ESCOMP/CISM-wrapper/tree/cism2_1_69 +components/clm https://github.com/ESCOMP/CTSM/tree/release-cesm2.2.01 +components/fms https://github.com/ESCOMP/FMS_interface/tree/fi_20200609 +components/mom https://github.com/ESCOMP/MOM_interface/mi_20200908 +components/mosart https://github.com/ESCOMP/MOSART/tree/mosart1_0_37 +components/pop https://github.com/ESCOMP/POP2-CESM/cesm_pop_2_1_20200730 +components/rtm https://github.com/ESCOMP/RTM/tree/rtm1_0_72 +components/ww3 https://github.com/ESCOMP/WW3-CESM/tree/ww3_190710 + +cam + Cheryl Craig 2023-03-02 - cam_cesm2_2_rel_07 - components/cam (cesm2.2.1-rc.01) + https://github.com/ESCOMP/CAM/tags/cam_cesm2_2_rel_07 + + For Francis Vitt + + Functional support for FHIST on refined SE grids + + + Cheryl Craig 2023-03-02 - cam_cesm2_2_rel_06 - components/cam (cesm2.2.1-rc.01) + https://github.com/ESCOMP/CAM/tags/cam_cesm2_2_rel_06 + + For Francis Vitt + + Transport CL and BR in WACCM-MA chemistry mechanisms + + Answer changing for WACCM-MA chemistry mechanisms + + + Cheryl Craig 2023-03-02 - cam_cesm2_2_rel_05 - components/cam (cesm2.2.1-rc.01) + https://github.com/ESCOMP/CAM/tags/cam_cesm2_2_rel_05 + + For Courtney Peverley + Secondary advection bug fix for CESM2.2 release + + Answer changing for all SE dycore runs + + + Cheryl Craig 2022-08-22 - cam_cesm2_2_rel_04 - components/cam (cesm2.2.1-rc.01) + https://github.com/ESCOMP/CAM/tags/cam_cesm2_2_rel_04 + + Fix three CAM-SE bugs + + some answer changes for SE runs + + + Chris Fischer 2020-09-24 - cam_cesm2_2_rel_03 - components/cam (cesm2.2.1-rc.01) + https://github.com/ESCOMP/CAM/tags/cam_cesm2_2_rel_03 + + Remove FCSCAM compset. + + +cime + Chris Fischer 2023-04-04 - cime5.8.32.1 - cime (cesm2.2.1-rc.01) + https://github.com/ESMCI/cime/tags/cime5.8.32.1 + + Update izumi domain name. + +=============================================================== +Tag name: cesm2.2.0-rc.01 +Originator(s): CSEG +Date: 15 September 2020 +One-line Summary: cesm2.2.0 release. + + +Component tags used for this CESM release candidate tag : + +components/cam https://github.com/ESCOMP/CAM/tree/cam_cesm2_2_rel_02 +components/cice https://github.com/ESCOMP/CESM_CICE5/tree/cice5_20200430 +cime https://github.com/ESMCI/cime/tree/cime5.8.32 +components/cism https://github.com/ESCOMP/CISM-wrapper/tree/cism2_1_69 +components/clm https://github.com/ESCOMP/CTSM/tree/release-cesm2.2.01 +components/fms https://github.com/ESCOMP/FMS_interface/tree/fi_20200609 +components/mom https://github.com/ESCOMP/MOM_interface/mi_20200908 +components/mosart https://github.com/ESCOMP/MOSART/tree/mosart1_0_37 +components/pop https://github.com/ESCOMP/POP2-CESM/cesm_pop_2_1_20200730 +components/rtm https://github.com/ESCOMP/RTM/tree/rtm1_0_72 +components/ww3 https://github.com/ESCOMP/WW3-CESM/tree/ww3_190710 + +cam + Cheryl Craig 2020-09-08 - cam_cesm2_2_rel_02 - components/cam (cesm2.2.0-rc.01) + https://github.com/ESCOMP/CAM/tags/cam_cesm2_2_rel_?? + + For Steve Goldhaber + + Fix failing FSCAM test with bug introduced in cam6_2_046 + + Fix FCHIST failing test + + Bug in WACCM-SE when molecular diffusion is > 0. Add an endrun so users can't run this configuration. + + + Francis Vitt 2020-07-15 - cam_cesm2_2_rel_01 - components/cam (cesm2.2.0-rc.01) + https://github.com/ESCOMP/CAM/tags/cam6_2_0?? + + Set up branch run refcases for FCnudged (and maybe FCHIST) compsets on CONUS refined grid. + + ** This is a tag on the CESM2.2 branch only + + +mom + Alper Altuntas 2020-09-10 - mi_20200908 - components/mom (cesm2.2.0-rc.01) + https://github.com/ESCOMP/MOM_interface/tags/mi_20200908 + + Update mom.input_data_list + =============================================================== Tag name: cesm2_2_beta06 Originator(s): CSEG diff --git a/Copyright b/Copyright deleted file mode 100644 index 113fac373c..0000000000 --- a/Copyright +++ /dev/null @@ -1,118 +0,0 @@ -CESM2 Copyright and Terms of Use - -Copyright (c) 2018, University Corporation for Atmospheric Research -(UCAR) All rights reserved. - -The Community Earth System Model (CESM) was developed primarily in -cooperation with the National Science Foundation, the Department of -Energy, the National Aeronautics and Space Administration, and the -University Corporation for Atmospheric Research National Center for -Atmospheric Research. - -THIS SOFTWARE IS PROVIDED BY UCAR AND ANY CONTRIBUTORS "AS IS" AND ANY -EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UCAR OR ANY CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF -THE POSSIBILITY OF SUCH DAMAGE. - -The following components are copyrighted and may only be used, modified, -or redistributed under the terms indicated below. - -Code Institution Copyright Terms of Use/Disclaimer ----- ----------- --------- ----------------------- -AER RRTMG Atmospheric Copyright AER RRTMG Copyright - and 2002-2010, - Environmental Atmospheric - Research, Inc. and - Environmental - Research, Inc. - -Common University Corporation Copyright 2017, CIME License -Infrastructure for Atmospheric University -for Modeling Research (UCAR) and DOE Corporation for -the Earth BER E3SM project team Atmospheric -(CIME) members, including Research (UCAR); - those at SNL and ANL Copyright 2017, - Sandia - Corporation; - Copyright 2017, - UChicago Argonne, - LLC - -ESMF University of Copyright University of Illinois/NCSA Open Source License - Illinois/NCSA 2002-2009, - University of - Illinois/NCSA - Open Source - License - -Functionally UCAR/NCAR, UC Berkeley Copyright 2017, FATES License -Assembled and DOE University -Terrestrial Corporation for -Ecosystem Atmospheric -Simulator Research (UCAR), -(FATES) the U.S. - Department of - Energy, and the - University of - California - -CISM Community NCAR/LANL/ORNL/SNL/ Copyright GNU Lesser General Public License v. 3 -Ice Sheet LBNL/NYU/U. Bristol/ 2004-2018, CISM is free software: you can redistribute it -Model U. Edinburgh/ GNU Lesser and/or modify it under the terms of the GNU - U. Montana/U. Swansea General Public Lesser General Public License as published by the - License v. 3 Free Software Foundation, either version 3 of the - License, or (at your option) any later version. - -Inf_NaN Lahey Copyright(c) Copies of this source code, or standalone compiled -_Detection Computer 2003, Lahey files derived from this source may not be sold -module Systems, Inc. Computer without permission from Lahey Computers Systems. - Systems, Inc. All or part of this module may be freely incorporated - into executable programs which are offered for sale. - Otherwise, distribution of all or part of this file is - permitted, provided this copyright notice and header - are included. - -International N/A Copyright 2003, ISCCP Simulator Software -Satellite 2010, Steve -Cloud Klein and Mark -Climatology Webb -Project -(ISCCP) - -MCT Argonne Copyright 2011, MCT Copyright - National University of - Laboratory Chicago - -Parallel Ocean Los Alamos National Copyright 2015, Los Alamos National Security, LLC -Program (POP2) Laboratory Los Alamos - National - Security, LLC - -The Los Alamos Los Alamos National Copyright 2017, Los Alamos National Security, LLC -Sea Ice Model Laboratory Los Alamos -(CICE) National - Security, LLC - -Spherical Los Alamos National Copyright 2015, Los Alamos National Security, LLC -Coordinate Laboratory Los Alamos -Remapping and National -Interpolation Security, LLC -Package (SCRIP) - -XML/Lite Wadsack-Allen Copyright 2001, The documentation for the Perl XML-Lite - Digital Group 2010 module is no longer available on-line. - Wadsack-Allen - Digital Group - -For more details on the copyrights of the above components, see -http://www.cesm.ucar.edu/models/cesm2/copyright.html - -There may be other third party tools and libraries that are integrated -into CESM, and they may have their own copyright notices and terms. diff --git a/Externals.cfg b/Externals.cfg index 4fbbeca456..cc3ab3922f 100644 --- a/Externals.cfg +++ b/Externals.cfg @@ -1,7 +1,7 @@ [cam] -tag = cam_cesm2_2_rel_00 +tag = cam_cesm2_2_rel_09_slh protocol = git -repo_url = https://github.com/ESCOMP/CAM +repo_url = https://github.com/RafaPedroFernandez/CAM local_path = components/cam externals = Externals_CAM.cfg required = True @@ -21,25 +21,25 @@ local_path = components/cdeps required = True [cime] -tag = cime5.8.32 +tag = cime5.8.32.9_slh protocol = git -repo_url = https://github.com/ESMCI/cime +repo_url = https://github.com/RafaPedroFernandez/cime local_path = cime externals = ../Externals_cime.cfg required = True [cism] -tag = cism2_1_69 +tag = cism2_1_69_slh protocol = git -repo_url = https://github.com/ESCOMP/CISM-wrapper +repo_url = https://github.com/RafaPedroFernandez/CISM-wrapper local_path = components/cism externals = Externals_CISM.cfg required = True [clm] -tag = release-cesm2.2.01 +tag = release-cesm2.2.01.asd01_slh protocol = git -repo_url = https://github.com/ESCOMP/CTSM +repo_url = https://github.com/RafaPedroFernandez/ctsm local_path = components/clm externals = Externals_CLM.cfg required = True @@ -53,7 +53,7 @@ externals = Externals_FMS.cfg required = False [mom] -tag = mi_20200826 +tag = mi_20200908 protocol = git repo_url = https://github.com/ESCOMP/MOM_interface local_path = components/mom @@ -61,7 +61,7 @@ externals = Externals.cfg required = False [mosart] -tag = mosart1_0_37 +tag = mosart1_0_37_1 protocol = git repo_url = https://github.com/ESCOMP/MOSART local_path = components/mosart diff --git a/LICENSE.txt b/LICENSE.txt index 69d97201e3..113fac373c 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,34 +1,118 @@ -Copyright (c) 2017, University Corporation for Atmospheric Research (UCAR) -All rights reserved. - -Developed by: - University Corporation for Atmospheric Research - National Center for Atmospheric Research - https://www2.cesm.ucar.edu/working-groups/sewg - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the "Software"), -to deal with the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, -and/or sell copies of the Software, and to permit persons to whom -the Software is furnished to do so, subject to the following conditions: - - - Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimers. - - Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimers in the documentation - and/or other materials provided with the distribution. - - Neither the names of [Name of Development Group, UCAR], - nor the names of its contributors may be used to endorse or promote - products derived from this Software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. +CESM2 Copyright and Terms of Use + +Copyright (c) 2018, University Corporation for Atmospheric Research +(UCAR) All rights reserved. + +The Community Earth System Model (CESM) was developed primarily in +cooperation with the National Science Foundation, the Department of +Energy, the National Aeronautics and Space Administration, and the +University Corporation for Atmospheric Research National Center for +Atmospheric Research. + +THIS SOFTWARE IS PROVIDED BY UCAR AND ANY CONTRIBUTORS "AS IS" AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UCAR OR ANY CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +THE POSSIBILITY OF SUCH DAMAGE. + +The following components are copyrighted and may only be used, modified, +or redistributed under the terms indicated below. + +Code Institution Copyright Terms of Use/Disclaimer +---- ----------- --------- ----------------------- +AER RRTMG Atmospheric Copyright AER RRTMG Copyright + and 2002-2010, + Environmental Atmospheric + Research, Inc. and + Environmental + Research, Inc. + +Common University Corporation Copyright 2017, CIME License +Infrastructure for Atmospheric University +for Modeling Research (UCAR) and DOE Corporation for +the Earth BER E3SM project team Atmospheric +(CIME) members, including Research (UCAR); + those at SNL and ANL Copyright 2017, + Sandia + Corporation; + Copyright 2017, + UChicago Argonne, + LLC + +ESMF University of Copyright University of Illinois/NCSA Open Source License + Illinois/NCSA 2002-2009, + University of + Illinois/NCSA + Open Source + License + +Functionally UCAR/NCAR, UC Berkeley Copyright 2017, FATES License +Assembled and DOE University +Terrestrial Corporation for +Ecosystem Atmospheric +Simulator Research (UCAR), +(FATES) the U.S. + Department of + Energy, and the + University of + California + +CISM Community NCAR/LANL/ORNL/SNL/ Copyright GNU Lesser General Public License v. 3 +Ice Sheet LBNL/NYU/U. Bristol/ 2004-2018, CISM is free software: you can redistribute it +Model U. Edinburgh/ GNU Lesser and/or modify it under the terms of the GNU + U. Montana/U. Swansea General Public Lesser General Public License as published by the + License v. 3 Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + +Inf_NaN Lahey Copyright(c) Copies of this source code, or standalone compiled +_Detection Computer 2003, Lahey files derived from this source may not be sold +module Systems, Inc. Computer without permission from Lahey Computers Systems. + Systems, Inc. All or part of this module may be freely incorporated + into executable programs which are offered for sale. + Otherwise, distribution of all or part of this file is + permitted, provided this copyright notice and header + are included. + +International N/A Copyright 2003, ISCCP Simulator Software +Satellite 2010, Steve +Cloud Klein and Mark +Climatology Webb +Project +(ISCCP) + +MCT Argonne Copyright 2011, MCT Copyright + National University of + Laboratory Chicago + +Parallel Ocean Los Alamos National Copyright 2015, Los Alamos National Security, LLC +Program (POP2) Laboratory Los Alamos + National + Security, LLC + +The Los Alamos Los Alamos National Copyright 2017, Los Alamos National Security, LLC +Sea Ice Model Laboratory Los Alamos +(CICE) National + Security, LLC + +Spherical Los Alamos National Copyright 2015, Los Alamos National Security, LLC +Coordinate Laboratory Los Alamos +Remapping and National +Interpolation Security, LLC +Package (SCRIP) + +XML/Lite Wadsack-Allen Copyright 2001, The documentation for the Perl XML-Lite + Digital Group 2010 module is no longer available on-line. + Wadsack-Allen + Digital Group + +For more details on the copyrights of the above components, see +http://www.cesm.ucar.edu/models/cesm2/copyright.html + +There may be other third party tools and libraries that are integrated +into CESM, and they may have their own copyright notices and terms. diff --git a/cime_config/config_compsets.xml b/cime_config/config_compsets.xml index 9a685f516c..731e6e23cd 100644 --- a/cime_config/config_compsets.xml +++ b/cime_config/config_compsets.xml @@ -52,11 +52,107 @@ 1850_CAM60%WCCM_CLM50%BGC-CROP_CICE_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + + BWSSP126cmip6 + SSP126_CAM60%WCTS_CLM50%BGC-CROP-CMIP6WACCMDECK_CICE%CMIP6_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + + BWSSP245cmip6 + SSP245_CAM60%WCTS_CLM50%BGC-CROP-CMIP6WACCMDECK_CICE%CMIP6_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + + + BWSSP370cmip6 + SSP370_CAM60%WCTS_CLM50%BGC-CROP-CMIP6WACCMDECK_CICE%CMIP6_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + BWSSP585cmip6 + SSP585_CAM60%WCTS_CLM50%BGC-CROP-CMIP6WACCMDECK_CICE%CMIP6_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + BWSSP534oscmip6 + SSP534_CAM60%WCTS_CLM50%BGC-CROP-CMIP6WACCMDECK_CICE%CMIP6_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + + + + + + + + + + BWSSPGENcmip6_slh + SSPGEN_CAM60%WCTSSLH_CLM50%BGC-CROP-CMIP6WACCMDECK_CICE%CMIP6_POP2%ECO%NDEP_MOSART_CISM2%NOEVOLVE_WW3 + + + + + + BHIST HIST_CAM60_CLM50%BGC-CROP_CICE_POP2%ECO_MOSART_CISM2%NOEVOLVE_WW3_BGC%BDRD + + + + + BSSP126cmip6 + SSP126_CAM60_CLM50%BGC-CROP-CMIP6DECK_CICE%CMIP6_POP2%ECO%ABIO-DIC_MOSART_CISM2%NOEVOLVE_WW3_BGC%BDRD + + + + + + BSSP245cmip6 + SSP245_CAM60_CLM50%BGC-CROP-CMIP6DECK_CICE%CMIP6_POP2%ECO%ABIO-DIC_MOSART_CISM2%NOEVOLVE_WW3_BGC%BDRD + + + + + + BCSSP245cmip6 + SSP245_CAM60%CCTS1_CLM50%BGC-CROP-CMIP6DECK_CICE%CMIP6_POP2%ECO%ABIO-DIC_MOSART_CISM2%NOEVOLVE_WW3_BGC%BDRD + + + + + + + BSSP370cmip6 + SSP370_CAM60_CLM50%BGC-CROP-CMIP6DECK_CICE%CMIP6_POP2%ECO%ABIO-DIC_MOSART_CISM2%NOEVOLVE_WW3_BGC%BDRD + + + + + + + + + + + + + + + BCSSPGENcmip6_slh + + SSPGEN_CAM60%CCTS1SLH_CLM50%BGC-CROP-CMIP6DECK_CICE%CMIP6_POP2%ECO%ABIO-DIC_MOSART_CISM2%NOEVOLVE_WW3_BGC%BDRD + + + + + + + + diff --git a/cime_config/config_pes.xml b/cime_config/config_pes.xml index 240a94c5b5..81da6b4860 100644 --- a/cime_config/config_pes.xml +++ b/cime_config/config_pes.xml @@ -210,7 +210,7 @@ -9 -9 -7 - -1 + -4 -1 -1 -16 @@ -1369,7 +1369,7 @@ -9 -9 -7 - -1 + -4 -1 -1 -16 diff --git a/doc/source/cesm_configurations.rst b/doc/source/cesm_configurations.rst index e859914fca..ad9a7e5024 100644 --- a/doc/source/cesm_configurations.rst +++ b/doc/source/cesm_configurations.rst @@ -1,11 +1,11 @@ .. _configurations: -=============================== -CESM Configurations (|version|) -=============================== +================================ +CESM2 Configurations (|version|) +================================ -The CESM system can be configured a number of different ways from both -a science and technical perspective. CESM supports numerous +The CESM2 system can be configured a number of different ways from both +a science and technical perspective. CESM2 supports numerous `resolutions `_, and `component sets @@ -42,13 +42,13 @@ of several modes: "active," "data," "dead," or "stub" that permits the whole system to activate and deactive component feedbacks by allowing for a variety of "plug and play" combinations. -During the course of a CESM run, the model components integrate forward +During the course of a CESM2 run, the model components integrate forward in time, periodically exchanging information with the coupler. The coupler meanwhile receives fields from the component models, computes, maps, and merges this information, then sends the fields back to the component models. The coupler brokers this sequence of communication interchanges and manages the overall time progression of -the coupled system. A CESM component set is comprised of eight +the coupled system. A CESM2 component set is comprised of eight components: one component from each model (atm, lnd, rof, ocn, ice, glc, wav, and esp) plus the coupler. Model components are written primarily in Fortran. @@ -68,7 +68,7 @@ so ice, ocn, and glc stubs are used). The CESM2 components can be summarized as follows: -.. csv-table:: "CESM model components" +.. csv-table:: "CESM2 model components" :header: "Component Generic Type", "Component Generic Name", "Component Name", "Component Type", "Description" :widths: 12, 10, 10, 10, 60 @@ -86,6 +86,7 @@ The CESM2 components can be summarized as follows: "river", "rof", "xrof", "dead", "Used only for testing the driver/coupler" "river", "rof", "srof", "stub", "Used only to satisy the interface requirements" "ocean", "ocn", "pop", "active", "The ocean model is an extension of the `Parallel Ocean Program (POP) `_ Version 2 from Los Alamos National Laboratory (LANL)." + "ocean", "ocn", "mom6", "active", "Based on the `Modular Ocean Model version 6 `_; an early functional release is available starting in CESM2.2. Note that MOM6 is not obtained by default; for instructions on obtaining it, see https://github.com/ESCOMP/MOM_interface/wiki/Detailed-Instructions." "ocean", "ocn", "docn", "data", "The `data ocean `_ component has two distinct modes of operation. It can run as a pure data model, reading ocean SSTs (normally climatological) from input datasets, interpolating in space and time, and then passing these to the coupler. Alternatively, docn can compute updated SSTs based on a slab ocean model where bottom ocean heat flux convergence and boundary layer depths are read in and used with the atmosphere/ocean and ice/ocean fluxes obtained from the coupler." "ocean", "ocn", "xocn", "dead" "ocean", "ocn", "socn", "stub" @@ -108,19 +109,68 @@ The CESM2 components can be combined in numerous ways to carry out various scientific or software experiments. A particular mix of components, *along with* component-specific configuration and/or namelist settings is called a `component set or compset -`_. CESM -has a shorthand naming convention for component sets that are -supported out-of-the-box. - -The compset name usually has a well defined first letter followed by -some characters that are indicative of the configuration setup. Each -compset name has a corresponding short name. +`_. CESM has a +shorthand naming convention (known as an alias) for component sets that +are supported out-of-the-box. The compset alias usually has a +well-defined first letter followed by some characters that are +indicative of the configuration setup. + +The first letter in a compset alias generally indicates which of the +components are fully active (prognostic), which are data components, and +which are completely absent (or stub). For the most part, this first +letter refers only to the atmosphere (atm), land (lnd), sea ice (ice) +and ocean (ocn) components. The type of component used for river (rof), +land ice (glc) and ocean wave (wav) is either specified in some other +way in the alias or is not specified explicitly. For example, an +evolving land ice (glc) model is denoted by a capital G near the end of +the compset alias (e.g., B1850G is similar to B1850 but with an evolving +Greenland ice sheet). In some cases, the distinction between prognostic +and data components is not clear-cut -- for example, when using a data +ocean model in slab ocean model (SOM) mode, or when using a prognostic +sea ice model (CICE) in prescribed mode. + +The following table summarizes these first-letter designations in +compset aliases: + +.. table:: + + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | Designation | Active Components | Data Components | Notes | + +=============+====================+=================+==========================================================================+ + | A | -- | various | All data components; used for software testing | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | B | atm, lnd, ice, ocn | -- | Fully active components | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | C | ocn | atm, ice, rof | \ | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | D | ice | atm, ocn, rof | Slab ocean model (SOM) | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | E | atm, lnd, ice | ocn | Slab ocean model (SOM) | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | F | atm, lnd | ice, ocn | Sea ice in prescribed mode; some F compsets use fewer surface components | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | G | ice, ocn | atm, rof | \ | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | I | lnd | atm | \ | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | J | lnd, ice, ocn | atm | Can be used to spin up the surface components | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | P | atm | -- | CAM PORT compsets | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | Q | atm | ocn | Aquaplanet compsets | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | S | -- | -- | No components present; used for software testing | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | T | glc | lnd | \ | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ + | X | -- | -- | Coupler-test components; used for software testing | + +-------------+--------------------+-----------------+--------------------------------------------------------------------------+ See `supported component sets `_ for a complete list of supported compset options. Running **query_config** with the ``--compsets`` option will also provide a listing of the -supported out-of-the-box component sets for the local version of CESM. +supported out-of-the-box component sets for the local version of CESM2. CESM2 Grids @@ -128,11 +178,11 @@ CESM2 Grids The `supported grid resolutions `_ are -specified in CESM by setting an overall model resolution. Once the +specified in CESM2 by setting an overall model resolution. Once the overall model resolution is set, components will read in appropriate grid files and the coupler will read in appropriate mapping weights files. Coupler mapping weights are always generated externally in -CESM. The components will send the grid data to the coupler at +CESM2. The components will send the grid data to the coupler at initialization, and the coupler will check that the component grids are consistent with each other and with the mapping weights files. @@ -141,7 +191,7 @@ atmosphere, land, river runoff and land ice can each be on different grids. Each component determines its own unique grid decomposition based upon the total number of pes or processing elements assigned to that component. -CESM supports several types of grids out-of-the-box including single +CESM2 supports several types of grids out-of-the-box including single point, finite volume, cubed sphere, displaced pole, and tripole. These grids are used internally by the models. Input datasets are usually on the same grid but in some cases, @@ -168,13 +218,13 @@ CESM2 Machines Scripts for `supported machines `_ and -userdefined machines are provided with the CESM release. Supported -machines have machine specific files and settings added to the CESM -scripts and are machines that should run CESM cases -out-of-the-box. Machines are supported in CESM on an individual basis +userdefined machines are provided with the CESM2 release. Supported +machines have machine specific files and settings added to the CESM2 +scripts and are machines that should run CESM2 cases +out-of-the-box. Machines are supported in CESM2 on an individual basis and are usually listed by their common site-specific name. To get a -machine ported and functionally supported in CESM, local batch, run, -environment, and compiler information must be configured in the CESM +machine ported and functionally supported in CESM2, local batch, run, +environment, and compiler information must be configured in the CESM2 scripts. The machine name "userdefined" machines refer to any machine that the user defines and requires that a user edit the resulting xml files to fill in information required for the target platform. This @@ -182,11 +232,11 @@ functionality is handy in accelerating the porting process and quickly getting a case running on a new platform. For more information on porting, see the `CIME porting guide `_. The -list of available machines are documented in `CESM supported machines +list of available machines are documented in `CESM2 supported machines `_. Running **query_config** with the ``--machines`` option will also show the list of all machines for the current local version of -CESM. Supported machines have undergone the full CESM porting +CESM. Supported machines have undergone the full CESM2 porting process. The machines available in each of these categories changes as access to machines change over time. @@ -194,7 +244,7 @@ access to machines change over time. CESM2 Validation ---------------- -Although CESM can be run out-of-the-box for a variety of resolutions, +Although CESM2 can be run out-of-the-box for a variety of resolutions, component combinations, and machines, MOST combinations of component sets, resolutions, and machines have not undergone rigorous scientific climate validation. Control runs accompany `scientifically supported diff --git a/doc/source/conf.py b/doc/source/conf.py index 0ac55316d6..c8cb3079f5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -64,9 +64,9 @@ # built documents. # # The short X.Y version. -version = u'Latest Development Code' +version = u'CESM2.2' # The full version, including alpha/beta/rc tags. -release = u'Latest Development Code' +release = u'CESM2.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/source/downloading_cesm.rst b/doc/source/downloading_cesm.rst index 1c7586df0f..f4b62b7808 100644 --- a/doc/source/downloading_cesm.rst +++ b/doc/source/downloading_cesm.rst @@ -1,8 +1,8 @@ .. _downloading: -============================ -Downloading CESM (|version|) -============================ +============================= +Downloading CESM2 (|version|) +============================= Downloading the code and scripts -------------------------------- @@ -19,22 +19,22 @@ software is at version 1.8.17. For more information or to download open source tools, visit `Subversion `_ and `git downloads `_. -With valid git and svn clients installed on the machine where CESM will be +With valid git and svn clients installed on the machine where CESM2 will be built and run, the user may download the latest version of the release code: .. code-block:: console - git clone https://github.com/ESCOMP/CESM.git my_cesm_sandbox + git clone -b release-cesm2.2.0 https://github.com/ESCOMP/CESM.git my_cesm_sandbox cd my_cesm_sandbox -To checkout a previous version of CESM, first view the available versions: +To checkout a previous version of CESM2, first view the available versions: .. code-block:: console git tag --list 'release-cesm2*' -To checkout a specific CESM release tag type, for example CESM2.0.1: +To checkout a specific CESM2 release tag type, for example CESM2.0.1: .. code-block:: console @@ -50,7 +50,7 @@ run the **checkout_externals** script from /path/to/my_cesm_sandbox. The **checkout_externals** script will read the configuration file called ``Externals.cfg`` and will download all the external component models and CIME into /path/to/my_cesm_sandbox. -Details regarding the CESM checkout process are available in the CESM GitHub repo +Details regarding the CESM2 checkout process are available in the CESM GitHub repo `README `_ To see more details regarding the checkout_externals script from the command line, type: @@ -82,25 +82,52 @@ columns of output, as in this example: Processing externals description file : Externals.cfg Processing externals description file : Externals_CLM.cfg + Processing externals description file : ../Externals_cime.cfg Processing externals description file : Externals_POP.cfg Processing externals description file : Externals_CISM.cfg - Checking status of externals: clm, fates, ptclm, mosart, ww3, cime, cice, pop, cvmix, marbl, cism, source_cism, rtm, cam, + Processing externals description file : .gitmodules + Processing submodules description file : .gitmodules + Processing externals description file : Externals_CAM.cfg + Checking status of externals: clm, fates, ptclm, mosart, cime, cmeps, ww3, cice, fms, pop, cvmix, marbl, cism, source_cism, rtm, cdeps, fox, mom, cam, silhs, clubb, pumas, atmos_phys, cosp2, chem_proc, atmos_cubed_sphere, carma, ./cime + e-o ./cime/src/drivers/nuopc/ ./components/cam + ./components/cam/chem_proc + ./components/cam/src/atmos_phys + ./components/cam/src/dynamics/fv3/atmos_cubed_sphere + ./components/cam/src/physics/carma/base + ./components/cam/src/physics/clubb + ./components/cam/src/physics/cosp2/src + ./components/cam/src/physics/pumas + ./components/cam/src/physics/silhs + ./components/cdeps + ./components/cdeps/fox ./components/cice ./components/cism ./components/cism/source_cism ./components/clm ./components/clm/src/fates ./components/clm/tools/PTCLM + e-o ./components/mom ./components/mosart ./components/pop ./components/pop/externals/CVMix ./components/pop/externals/MARBL ./components/rtm ./components/ww3 + e-o ./libraries/FMS + + +You should now have a default copy of the CESM2 source code in your /path/to/my_cesm_sandbox. + +These components are optional and are not needed to run CESM2. + +.. code-block:: console + + e-o ./cime/src/drivers/nuopc/ + e-o ./components/mom + e-o ./libraries/FMS -You should now have a complete copy of the CESM2 source code in your /path/to/my_cesm_sandbox. If there were problems obtaining an external, you might instead see something like: diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index a1cd59dc7e..98b156530b 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -15,7 +15,7 @@ If you are new to CESM2, please consider reading the This is the procedure for quickly setting up and running a CESM2 case. -Download CESM2 (see `Downloading CESM2 `_). +Download CESM2 (see `Downloading CESM2 `_). Select a component set, and a resolution for your case. Details of available component sets and resolutions are available from the `query_config`_ tool located