Skip to content

Commit

Permalink
Add initial version of files based on clm5.0.000 and cesm2_0_alpha09a…
Browse files Browse the repository at this point in the history
…, doesn't build as clm src directories aren't complete
  • Loading branch information
ekluzek committed Feb 9, 2018
1 parent f0a8c3e commit 65ad633
Show file tree
Hide file tree
Showing 108 changed files with 54,074 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .config_files.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" ?>

<entry_id>

<!-- This is the same as the default entry in
cime/config/cesm/config_files.xml except for the value for clm:
In a standalone clm checkout, COMP_ROOT_DIR_LND is $SRCROOT
rather than $SRCROOT/components/clm.
However, because of the way overrides are handled, we need to
re-specify the full information here rather than just overriding
the value for clm.
-->
<entry id="COMP_ROOT_DIR_LND">
<type>char</type>
<default_value>unset</default_value>
<values>
<value component="clm" >$SRCROOT</value>
<value component="dlnd" >$CIMEROOT/src/components/data_comps/dlnd</value>
<value component="slnd" >$CIMEROOT/src/components/stub_comps/slnd</value>
<value component="xlnd" >$CIMEROOT/src/components/xcpl_comps/xlnd</value>
</values>
<group>case_comps</group>
<file>env_case.xml</file>
<desc>Root directory of the case land model component </desc>
<schema>$CIMEROOT/config/xml_schemas/config_compsets.xsd</schema>
</entry>

</entry_id>
31 changes: 31 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# directories checked out by manage_externals, and other files created
# by manage_externals
manage_externals.log
cime/
components/

# ignore svn directories
**/.svn/**
.svn/

# binary files
*.nc

# editor files
*.swp
*~

# mac files
.DS_Store

# cmake generated files
build/
CMakeFiles/

# build output
*.o
*.mod
core.*
*.gz
*.log !run.log
*.pyc
74 changes: 74 additions & 0 deletions Copyright
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
CESM1.5: Copyright Notice and Disclaimer

The Community Earth System Model (CESM was developed 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.

Except for the segregable components listed below, CESM is public domain software.
There may be other third party tools and libraries that are embedded, and
they may have their own copyright notices and terms.

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
---- ----------- --------- -----------------------
ESMF University of Copyright University of Illinois/NCSA Open Source License
Illinois/NCSA 2002-2009,
University of
Illinois/NCSA
Open Source
License

POP,SCRIP,CICE Los Alamos National Copyright 2008 Los Alamos National Security, LLC
Laboratory Los Alamos
National
Security, LLC

Glimmer-CISM LANL/U. Copyright GNU General Public License
Bristol/U. 2004-2010,
Edinburgh/U. GNU General
Montana/U. Public License
Swansea

AER RRTMG Atmospheric Copyright AER RRTMG Copyright
and 2002-2010,
Environmental Atmospheric
Research, Inc. and
Environmental
Research, Inc.

MCT Argonne Copyright 2000, MCT Copyright
National 2010,
Laboratory University of
Chicago.

ICSSP N/A Copyright 2003, ISCCP Simulator Software
2010, Steve
Klein and Mark
Webb

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

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.


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.

36 changes: 36 additions & 0 deletions Externals.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[slm]
local_path = .
protocol = externals_only
required = True

[cam]
tag = trunk_tags/cam5_4_161/components/cam
protocol = svn
repo_url = https://svn-ccsm-models.cgd.ucar.edu/cam1
local_path = components/cam
required = True

[cice]
tag = cice5_20180123
protocol = git
repo_url = https://github.com/ESCOMP/CESM_CICE5
local_path = components/cice
required = True

[rtm]
tag = rtm1_0_65
protocol = git
repo_url = https://github.com/ESCOMP/rtm
local_path = components/rtm
required = True

[cime]
tag = clm4518/n04/cime5.4.0-alpha.03
protocol = git
repo_url = https://github.com/CESM-Development/cime
local_path = cime
required = True

[externals_description]
schema_version = 1.0.0

34 changes: 34 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Copyright (c) 2005-2018, 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.
25 changes: 25 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=============================================================================================
Important files in main directories:
=============================================================================================

Externals.cfg --------------- File for management of the main high level externals
Externals_CLM.cfg ----------- File for management of the CLM specific externals (i.e. FATES)

bld/configure --------------- Script to prepare CLM to be built.

=============================================================================================
QUICKSTART: using the CPL7 scripts:
=============================================================================================

cd cime/scripts
./create_newcase # get help on how to run create_newcase
./create_newcase --case testI --res f19_g16 --compset I2000Clm50BgcCrop --mach cheyenne
# create new "I" case for cheyenne_intel at 1.9x2.5_gx1v7 res
# "I2000Clm50BgcCrop" case is clm5_0 active, datm8, and inactive ice/ocn
cd testI
./case.setup # create the $CASE.run file
./case.build # build model and create namelists
./case.submit # submit script
# (NOTE: ./xmlchange RESUBMIT=10 to set RESUBMIT to number
# # of times to automatically resubmit -- 10 in this example)

3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
================
SimpleLandModel
================
107 changes: 107 additions & 0 deletions README_EXTERNALS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
Obtaining the full model code and associated scripting infrastructure
=====================================================================

#. Clone the repository. ::


#. Run the script **manage_externals/checkout_externals**. ::

./manage_externals/checkout_externals

The **checkout_externals** script is a package manager that will
populate the directory with the relevant versions of each of the
components along with the CIME infrastructure code.

At this point you have a working version.

To see full details of how to set up a case, compile and run, see the CIME documentation at http://esmci.github.io/cime/ .

More details on checkout_externals
----------------------------------

The file **Externals.cfg** in your top-level directory tells
**checkout_externals** which tag/branch of each component should be
brought in to generate your sandbox.

**You need to rerun checkout_externals whenever Externals.cfg has
changed** (unless you have already manually updated the relevant
external(s) to have the correct branch/tag checked out). Common times
when this is needed are:

* After checking out a new branch/tag

* After merging some other branch/tag into your currently
checked-out branch

**checkout_externals** must be run from the root of the source
tree. For example, if you cloned with::

git clone https://github.com/escomp/ctsm.git my_ctsm_sandbox

then you must run **checkout_externals** from
``/path/to/my_ctsm_sandbox``.

To see more details of **checkout_externals**, issue ::

./manage_externals/checkout_externals --help

Customizing your sandbox
=============================

There are several use cases to consider when you want to customize or modify your sandbox.

Switching to a different branch or tag
-------------------------------------------

If you have already checked out a branch or tag and **HAVE NOT MADE ANY
MODIFICATIONS** it is simple to change your sandbox. Say that you
checked out ctsm1.0.0 but really wanted to have ctsm1.1.0;
you would simply do the following::

git checkout ctsm1.1.0
./manage_externals/checkout_externals

You should **not** use this method if you have made any source code
changes, or if you have any ongoing cases that were created from
this sandbox. In these cases, it is often easiest to do a second **git
clone**.

Pointing to a different version of a component
----------------------------------------------

Each entry in **Externals.cfg** has the following form (we use CIME as an
example below)::

[cime]
local_path = cime
protocol = git
repo_url = https://github.com/CESM-Development/cime
tag = cime5.4.0-alpha.20
required = True

Each entry specifies either a tag or a branch. To point to a new tag:

#. Modify the relevant entry/entries in **Externals.cfg** (e.g., changing
``cime5.4.0-alpha.20`` to ``cime5.4.0-alpha.21`` above)

#. Checkout the new component(s)::

./manage_externals/checkout_externals

Keep in mind that changing individual components from a tag may result
in an invalid model (won't compile, won't run, not scientifically
meaningful) and is unsupported.

Committing your change to Externals.cfg
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

After making this change, it's a good idea to commit the change in your
local git repository. First create a branch in your local
repository, then commit it. (Unlike with subversion, branches are stored
locally unless you explicitly push them up to github. Feel free to
create whatever local branches you'd like.) For example::

git checkout -b my_ctsm_branch
git add Externals.cfg
git commit -m "Update CIME to cime5.4.0-alpha.20"

1 change: 1 addition & 0 deletions bld/CESM_cppdefs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Loading

0 comments on commit 65ad633

Please sign in to comment.