CIME.BuildTools package
+CIME.BuildTools package
Submodules
+Submodules
CIME.BuildTools.configure module
+CIME.BuildTools.configure module
This script writes CIME build information to a directory.
The pieces of information that will be written include:
-
@@ -157,27 +158,27 @@
- -class CIME.BuildTools.configure.FakeCase(compiler, mpilib, debug, comp_interface, threading=False)[source] +class CIME.BuildTools.configure.FakeCase(compiler, mpilib, debug, comp_interface, threading=False)[source]
Bases:
object- -set_value(attrib, value)[source] +set_value(attrib, value)[source]
Sets a given variable value for the case
Submodules
- -CIME.BuildTools.configure.configure(machobj, output_dir, macros_format, compiler, mpilib, debug, comp_interface, sysos, unit_testing=False, noenv=False, threaded=False, extra_machines_dir=None)[source]
+CIME.BuildTools.configure.configure(machobj, output_dir, macros_format, compiler, mpilib, debug, comp_interface, sysos, unit_testing=False, noenv=False, threaded=False, extra_machines_dir=None)[source]Add Macros, Depends, and env_mach_specific files to a directory.
Arguments: machobj - Machines argument for this machine. @@ -209,20 +210,20 @@
Submodules
- -CIME.BuildTools.configure.copy_depends_files(machine_name, machines_dir, output_dir, compiler)[source]
+CIME.BuildTools.configure.copy_depends_files(machine_name, machines_dir, output_dir, compiler)[source]Copy any system or compiler Depends files if they do not exist in the output directory If there is a match for Depends.machine_name.compiler copy that and ignore the others
- -CIME.BuildTools.configure.generate_env_mach_specific(output_dir, machobj, compiler, mpilib, debug, comp_interface, sysos, unit_testing, threaded, noenv=False)[source] +CIME.BuildTools.configure.generate_env_mach_specific(output_dir, machobj, compiler, mpilib, debug, comp_interface, sysos, unit_testing, threaded, noenv=False)[source]
env_mach_specific generation.
Submodules
Module contents
+Module contents
CIME.Servers package
+CIME.Servers package
Submodules
+Submodules
CIME.Servers.ftp module
+CIME.Servers.ftp module
FTP Server class. Interact with a server using FTP protocol
- -class CIME.Servers.ftp.FTP(address, user='', passwd='', server=None)[source] +class CIME.Servers.ftp.FTP(address, user='', passwd='', server=None)[source]
Bases:
GenericServer- -fileexists(rel_path)[source] +fileexists(rel_path)[source]
Returns True if rel_path exists on server
- -classmethod ftp_login(address, user='', passwd='')[source] +classmethod ftp_login(address, user='', passwd='')[source]
- -getfile(rel_path, full_path)[source] +getfile(rel_path, full_path)[source]
Get file from rel_path on server and place in location full_path on client fail if full_path already exists on client, return True if successful
Submodules -
CIME.Servers.generic_server module
+CIME.Servers.generic_server module
Generic Server class. There should be little or no functionality in this class, it serves only to make sure that specific server classes maintain a consistant argument list and functionality so that they are interchangable objects
- -class CIME.Servers.generic_server.GenericServer(host=' ', user=' ', passwd=' ', acct=' ', timeout=<object object>)[source] +class CIME.Servers.generic_server.GenericServer(host=' ', user=' ', passwd=' ', acct=' ', timeout=<object object>)[source]
Bases:
object- -fileexists(rel_path)[source] +fileexists(rel_path)[source]
Returns True if rel_path exists on server
- -getfile(rel_path, full_path)[source] +getfile(rel_path, full_path)[source]
Get file from rel_path on server and place in location full_path on client fail if full_path already exists on client, return True if successful
Submodules -
CIME.Servers.gftp module
+CIME.Servers.gftp module
GridFTP Server class. Interact with a server using GridFTP protocol
- -class CIME.Servers.gftp.GridFTP(address, user='', passwd='')[source] +class CIME.Servers.gftp.GridFTP(address, user='', passwd='')[source]
Bases:
GenericServer- -fileexists(rel_path)[source] +fileexists(rel_path)[source]
Returns True if rel_path exists on server
- -getfile(rel_path, full_path)[source] +getfile(rel_path, full_path)[source]
Get file from rel_path on server and place in location full_path on client fail if full_path already exists on client, return True if successful
Submodules -
CIME.Servers.svn module
+CIME.Servers.svn module
SVN Server class. Interact with a server using SVN protocol
- -class CIME.Servers.svn.SVN(address, user='', passwd='')[source] +class CIME.Servers.svn.SVN(address, user='', passwd='')[source]
Bases:
GenericServer- -fileexists(rel_path)[source] +fileexists(rel_path)[source]
Returns True if rel_path exists on server
- -getfile(rel_path, full_path)[source] +getfile(rel_path, full_path)[source]
Get file from rel_path on server and place in location full_path on client fail if full_path already exists on client, return True if successful
Submodules -
CIME.Servers.wget module
+CIME.Servers.wget module
WGET Server class. Interact with a server using WGET protocol
- -class CIME.Servers.wget.WGET(address, user='', passwd='')[source] +class CIME.Servers.wget.WGET(address, user='', passwd='')[source]
Bases:
GenericServer- -fileexists(rel_path)[source] +fileexists(rel_path)[source]
Returns True if rel_path exists on server
Module contents
+Module contents
CIME.SystemTests package
+CIME.SystemTests package
Subpackages
+Subpackages
- CIME.SystemTests.test_utils package
-
@@ -155,17 +156,17 @@
- -class CIME.SystemTests.dae.DAE(case, **kwargs)[source] +class CIME.SystemTests.dae.DAE(case, **kwargs)[source]
Bases:
SystemTestsCompareTwoImplementation of the CIME data assimilation test: Compares standard run with a run broken into two data assimilation cycles. @@ -175,7 +176,7 @@
Submodules
- -run_phase()[source]
+run_phase()[source]Runs both phases of the two-phase test and compares their results If success_change is True, success requires some files to be different
- -class CIME.SystemTests.eri.ERI(case, **kwargs)[source] +class CIME.SystemTests.eri.ERI(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -202,16 +203,16 @@Submodules -
CIME.SystemTests.erio module
+CIME.SystemTests.erio module
ERIO tests restart with different PIO methods
This class inherits from SystemTestsCommon
- -class CIME.SystemTests.erio.ERIO(case, **kwargs)[source] +class CIME.SystemTests.erio.ERIO(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -221,7 +222,7 @@Submodules -
CIME.SystemTests.erp module
+CIME.SystemTests.erp module
CIME ERP test. This class inherits from RestartTest
This is a pes counts hybrid (open-MP/MPI) restart bfb test from startup. This is just like an ERS test but the pe-counts/threading @@ -230,43 +231,43 @@
Submodules
- -class CIME.SystemTests.erp.ERP(case, **kwargs)[source]
+class CIME.SystemTests.erp.ERP(case, **kwargs)[source]Bases:
RestartTest
- -class CIME.SystemTests.err.ERR(case, **kwargs)[source] +class CIME.SystemTests.err.ERR(case, **kwargs)[source]
Bases:
RestartTest- -class CIME.SystemTests.ers.ERS(case, **kwargs)[source] +class CIME.SystemTests.ers.ERS(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -276,15 +277,15 @@Submodules -
CIME.SystemTests.ers2 module
+CIME.SystemTests.ers2 module
CIME restart test 2 This class inherits from SystemTestsCommon
- -class CIME.SystemTests.ers2.ERS2(case, **kwargs)[source] +class CIME.SystemTests.ers2.ERS2(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -294,16 +295,16 @@Submodules -
CIME.SystemTests.ert module
+CIME.SystemTests.ert module
CIME production restart test This class inherits from SystemTestsCommon Exact restart from startup, default 2 month + 1 month
- -class CIME.SystemTests.ert.ERT(case, **kwargs)[source] +class CIME.SystemTests.ert.ERT(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -313,16 +314,16 @@Submodules -
CIME.SystemTests.funit module
+CIME.SystemTests.funit module
CIME FUNIT test. This class inherits from SystemTestsCommon. It runs the fortran unit tests; grid and compset are ignored.
- -class CIME.SystemTests.funit.FUNIT(case, **kwargs)[source] +class CIME.SystemTests.funit.FUNIT(case, **kwargs)[source]
Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -331,13 +332,13 @@Submodules
- -get_test_spec_dir()[source]
+get_test_spec_dir()[source]Override this to change what gets tested.
- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -347,24 +348,24 @@Submodules -
CIME.SystemTests.homme module
+CIME.SystemTests.homme module
- -class CIME.SystemTests.hommebaseclass.HommeBase(case, **kwargs)[source] +class CIME.SystemTests.hommebaseclass.HommeBase(case, **kwargs)[source]
Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -373,7 +374,7 @@Submodules
- -run_phase()[source]
+run_phase()[source]This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -383,24 +384,24 @@Submodules -
CIME.SystemTests.hommebfb module
+CIME.SystemTests.hommebfb module
- -class CIME.SystemTests.icp.ICP(case, **kwargs)[source] +class CIME.SystemTests.icp.ICP(case, **kwargs)[source]
Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -409,7 +410,7 @@Submodules
- -run_phase()[source]
+run_phase()[source]This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -419,7 +420,7 @@Submodules -
CIME.SystemTests.irt module
+CIME.SystemTests.irt module
Implementation of the CIME IRT. (Interim Restart Test) This test the model’s restart capability as well as the short term archiver’s interim restart capability
- -class CIME.SystemTests.ldsta.LDSTA(case, **kwargs)[source] +class CIME.SystemTests.ldsta.LDSTA(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -458,7 +459,7 @@Submodules -
CIME.SystemTests.mcc module
+CIME.SystemTests.mcc module
Implemetation of CIME MCC test: Compares ensemble methods
- This does two runs: In the first we run a three member ensemble using the
MULTI_DRIVER capability, then we run a second single instance case and compare
@@ -466,24 +467,24 @@Submodules
- -class CIME.SystemTests.mcc.MCC(case, **kwargs)[source]
+class CIME.SystemTests.mcc.MCC(case, **kwargs)[source]Bases:
SystemTestsCompareTwo
- -class CIME.SystemTests.mvk.MVK(case, **kwargs)[source] +class CIME.SystemTests.mvk.MVK(case, **kwargs)[source]
Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -494,7 +495,7 @@Submodules -
CIME.SystemTests.nck module
+CIME.SystemTests.nck module
Implementation of the CIME NCK test: Tests multi-instance
This does two runs: In the first, we use one instance per component; in the second, we use two instances per components. NTASKS are changed in each run so @@ -502,13 +503,13 @@
Submodules
- -class CIME.SystemTests.nck.NCK(case, **kwargs)[source]
+class CIME.SystemTests.nck.NCK(case, **kwargs)[source]Bases:
SystemTestsCompareTwo
- -class CIME.SystemTests.ncr.NCR(case, **kwargs)[source] +class CIME.SystemTests.ncr.NCR(case, **kwargs)[source]
Bases:
SystemTestsCompareTwo- -class CIME.SystemTests.nodefail.NODEFAIL(case, **kwargs)[source] +class CIME.SystemTests.nodefail.NODEFAIL(case, **kwargs)[source]
Bases:
ERS- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -541,20 +542,20 @@Submodules -
CIME.SystemTests.pea module
+CIME.SystemTests.pea module
Implementation of the CIME PEA test.
Builds runs and compares a single processor mpi model to a model built using mpi-serial (1) do a run with default mpi library (suffix base) (2) do a run with mpi-serial (suffix mpi-serial)
- -class CIME.SystemTests.pea.PEA(case, **kwargs)[source] +class CIME.SystemTests.pea.PEA(case, **kwargs)[source]
Bases:
SystemTestsCompareTwo
- -class CIME.SystemTests.pem.PEM(case, **kwargs)[source] +class CIME.SystemTests.pem.PEM(case, **kwargs)[source]
Bases:
SystemTestsCompareTwo- -class CIME.SystemTests.pet.PET(case, **kwargs)[source] +class CIME.SystemTests.pet.PET(case, **kwargs)[source]
Bases:
SystemTestsCompareTwo- -class CIME.SystemTests.pfs.PFS(case, **kwargs)[source] +class CIME.SystemTests.pfs.PFS(case, **kwargs)[source]
Bases:
SystemTestsCommon- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -601,18 +602,18 @@Submodules -
CIME.SystemTests.pgn module
+CIME.SystemTests.pgn module
Perturbation Growth New (PGN) - The CESM/ACME model’s multi-instance capability is used to conduct an ensemble of simulations starting from different initial conditions.
This class inherits from SystemTestsCommon.
- -class CIME.SystemTests.pgn.PGN(case, **kwargs)[source] +class CIME.SystemTests.pgn.PGN(case, **kwargs)[source]
Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -621,13 +622,13 @@Submodules
- -get_var_list()[source]
+get_var_list()[source]Get variable list for pergro specific output vars
- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -637,7 +638,7 @@Submodules -
CIME.SystemTests.pre module
+CIME.SystemTests.pre module
Implementation of the CIME pause/resume test: Tests having driver ‘pause’ (write cpl restart file) and ‘resume’ (read cpl restart file) possibly changing the restart file. Compared to non-pause/resume run. @@ -645,7 +646,7 @@
Submodules
- -class CIME.SystemTests.pre.PRE(case, **kwargs)[source]
+class CIME.SystemTests.pre.PRE(case, **kwargs)[source]Bases:
SystemTestsCompareTwoImplementation of the CIME pause/resume test: Tests having driver ‘pause’ (write cpl and/or other restart file(s)) and ‘resume’ @@ -653,7 +654,7 @@
Submodules
- -run_phase()[source]
+run_phase()[source]Runs both phases of the two-phase test and compares their results If success_change is True, success requires some files to be different
Submodules -
CIME.SystemTests.rep module
+CIME.SystemTests.rep module
Implementation of the CIME REP test
This test verifies that two identical runs give bit-for-bit results
- -class CIME.SystemTests.rep.REP(case, **kwargs)[source] +class CIME.SystemTests.rep.REP(case, **kwargs)[source]
Bases:
SystemTestsCompareTwo
- -class CIME.SystemTests.restart_tests.RestartTest(case, separate_builds, run_two_suffix='restart', run_one_description='initial', run_two_description='restart', multisubmit=False, **kwargs)[source] +class CIME.SystemTests.restart_tests.RestartTest(case, separate_builds, run_two_suffix='restart', run_one_description='initial', run_two_description='restart', multisubmit=False, **kwargs)[source]
Bases:
SystemTestsCompareTwo- -class CIME.SystemTests.seq.SEQ(case, **kwargs)[source] +class CIME.SystemTests.seq.SEQ(case, **kwargs)[source]
Bases:
SystemTestsCompareTwo- -class CIME.SystemTests.sms.SMS(case, **kwargs)[source] +class CIME.SystemTests.sms.SMS(case, **kwargs)[source]
Bases:
SystemTestsCommon- -class CIME.SystemTests.system_tests_common.FakeTest(case, expected=None, **kwargs)[source] +class CIME.SystemTests.system_tests_common.FakeTest(case, expected=None, **kwargs)[source]
Bases:
SystemTestsCommonInheriters of the FakeTest Class are intended to test the code.
All members of the FakeTest Class must @@ -734,7 +735,7 @@
Submodules
- -build_phase(sharedlib_only=False, model_only=False)[source]
+build_phase(sharedlib_only=False, model_only=False)[source]This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -743,7 +744,7 @@Submodules
- -run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)[source]
+run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)[source]Perform an individual run. Raises an EXCEPTION on fail.
keep_init_generated_files: If False (the default), we remove the init_generated_files subdirectory of the run directory before running the case. @@ -755,11 +756,11 @@
Submodules
- -class CIME.SystemTests.system_tests_common.SystemTestsCommon(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.SystemTestsCommon(case, expected=None, **kwargs)[source]Bases:
object- -build(sharedlib_only=False, model_only=False, ninja=False, dry_run=False, separate_builds=False, skip_submit=False)[source] +build(sharedlib_only=False, model_only=False, ninja=False, dry_run=False, separate_builds=False, skip_submit=False)[source]
Do NOT override this method, this method is the framework that controls the build phase. build_phase is the extension point that subclasses should use.
@@ -767,13 +768,13 @@Submodules
- -build_indv(sharedlib_only=False, model_only=False)[source]
+build_indv(sharedlib_only=False, model_only=False)[source]Perform an individual build
- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -782,25 +783,25 @@Submodules
- -clean_build(comps=None)[source]
+clean_build(comps=None)[source]
- -compare_env_run(expected=None)[source] +compare_env_run(expected=None)[source]
Compare env_run file to original and warn about differences
- -run(skip_pnl=False)[source] +run(skip_pnl=False)[source]
Do NOT override this method, this method is the framework that controls the run phase. run_phase is the extension point that subclasses should use.
- -run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)[source] +run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)[source]
Perform an individual run. Raises an EXCEPTION on fail.
keep_init_generated_files: If False (the default), we remove the init_generated_files subdirectory of the run directory before running the case. @@ -810,7 +811,7 @@
Submodules
- -run_phase()[source]
+run_phase()[source]This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -820,11 +821,11 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTBUILDFAIL(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTBUILDFAIL(case, expected=None, **kwargs)[source]Bases:
TESTRUNPASS- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -835,17 +836,17 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTBUILDFAILEXC(case, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTBUILDFAILEXC(case, **kwargs)[source]Bases:
FakeTest
- -class CIME.SystemTests.system_tests_common.TESTMEMLEAKFAIL(case, expected=None, **kwargs)[source] +class CIME.SystemTests.system_tests_common.TESTMEMLEAKFAIL(case, expected=None, **kwargs)[source]
Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -856,11 +857,11 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTMEMLEAKPASS(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTMEMLEAKPASS(case, expected=None, **kwargs)[source]Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -871,7 +872,7 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNDIFF(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNDIFF(case, expected=None, **kwargs)[source]Bases:
FakeTestYou can generate a diff with this test as follows: 1) Run the test and generate a baseline @@ -882,7 +883,7 @@
Submodules
- -build_phase(sharedlib_only=False, model_only=False)[source]
+build_phase(sharedlib_only=False, model_only=False)[source]This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -893,17 +894,17 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNDIFFRESUBMIT(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNDIFFRESUBMIT(case, expected=None, **kwargs)[source]Bases:
TESTRUNDIFF
- -class CIME.SystemTests.system_tests_common.TESTRUNFAIL(case, expected=None, **kwargs)[source] +class CIME.SystemTests.system_tests_common.TESTRUNFAIL(case, expected=None, **kwargs)[source]
Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -914,11 +915,11 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNFAILEXC(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNFAILEXC(case, expected=None, **kwargs)[source]Bases:
TESTRUNPASS- -run_phase()[source] +run_phase()[source]
This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -928,7 +929,7 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNFAILRESET(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNFAILRESET(case, expected=None, **kwargs)[source]Bases:
TESTRUNFAILThis fake test can fail for two reasons: 1. As in the TESTRUNFAIL test: If the environment variable TESTRUNFAIL_PASS is not set @@ -940,7 +941,7 @@
Submodules
- -run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)[source]
+run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)[source]Perform an individual run. Raises an EXCEPTION on fail.
keep_init_generated_files: If False (the default), we remove the init_generated_files subdirectory of the run directory before running the case. @@ -952,11 +953,11 @@
Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNPASS(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNPASS(case, expected=None, **kwargs)[source]Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -967,11 +968,11 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNSLOWPASS(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNSLOWPASS(case, expected=None, **kwargs)[source]Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -982,17 +983,17 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTRUNSTARCFAIL(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTRUNSTARCFAIL(case, expected=None, **kwargs)[source]Bases:
TESTRUNPASS
- -class CIME.SystemTests.system_tests_common.TESTRUNUSERXMLCHANGE(case, expected=None, **kwargs)[source] +class CIME.SystemTests.system_tests_common.TESTRUNUSERXMLCHANGE(case, expected=None, **kwargs)[source]
Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -1001,7 +1002,7 @@Submodules
- -run_phase()[source]
+run_phase()[source]This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -1011,11 +1012,11 @@Submodules
- -class CIME.SystemTests.system_tests_common.TESTTESTDIFF(case, expected=None, **kwargs)[source]
+class CIME.SystemTests.system_tests_common.TESTTESTDIFF(case, expected=None, **kwargs)[source]Bases:
FakeTest- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -1024,7 +1025,7 @@Submodules
- -run_phase()[source]
+run_phase()[source]This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -1034,7 +1035,7 @@Submodules
- -CIME.SystemTests.system_tests_common.fix_single_exe_case(case)[source]
+CIME.SystemTests.system_tests_common.fix_single_exe_case(case)[source]Fixes cases created with –single-exe.
When tests are created using –single-exe, the test_scheduler will set BUILD_COMPLETE to True, but some tests require calls to case.case_setup @@ -1048,7 +1049,7 @@
Submodules
- -CIME.SystemTests.system_tests_common.is_single_exe_case(case)[source]
+CIME.SystemTests.system_tests_common.is_single_exe_case(case)[source]Determines if the case was created with the –single-exe option.
If CASEROOT is not part of EXEROOT and the TEST variable is True, then its safe to assume the case was created with ./create_test @@ -1059,9 +1060,14 @@
Submodules +
- +CIME.SystemTests.system_tests_common.perf_check_for_memory_leak(case, tolerance)[source]
+
- -class CIME.SystemTests.system_tests_compare_n.SystemTestsCompareN(case, N=2, separate_builds=False, run_suffixes=None, run_descriptions=None, multisubmit=False, ignore_fieldlist_diffs=False, dry_run=False, **kwargs)[source] +class CIME.SystemTests.system_tests_compare_n.SystemTestsCompareN(case, N=2, separate_builds=False, run_suffixes=None, run_descriptions=None, multisubmit=False, ignore_fieldlist_diffs=False, dry_run=False, **kwargs)[source]
Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -1114,7 +1120,7 @@Submodules
- -run_phase(success_change=False)[source]
+run_phase(success_change=False)[source]Runs all phases of the N-phase test and compares base results with subsequent ones If success_change is True, success requires some files to be different
Submodules -
CIME.SystemTests.system_tests_compare_two module
+CIME.SystemTests.system_tests_compare_two module
Base class for CIME system tests that involve doing two runs and comparing their output.
NOTE: Below is the flow of a multisubmit test. @@ -1165,11 +1171,11 @@
Submodules
- -class CIME.SystemTests.system_tests_compare_two.SystemTestsCompareTwo(case, separate_builds=False, run_two_suffix='test', run_one_description='', run_two_description='', multisubmit=False, ignore_fieldlist_diffs=False, case_two_keep_init_generated_files=False, dry_run=False, **kwargs)[source]
+class CIME.SystemTests.system_tests_compare_two.SystemTestsCompareTwo(case, separate_builds=False, run_two_suffix='test', run_one_description='', run_two_description='', multisubmit=False, ignore_fieldlist_diffs=False, case_two_keep_init_generated_files=False, dry_run=False, **kwargs)[source]Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -1178,7 +1184,7 @@Submodules
- -copy_case1_restarts_to_case2()[source]
+copy_case1_restarts_to_case2()[source]Makes a copy (or symlink) of restart files and related files (necessary history files, rpointer files) from case1 to case2.
This is not done automatically, but can be called by individual @@ -1188,7 +1194,7 @@
Submodules
- -run_phase(success_change=False)[source]
+run_phase(success_change=False)[source]Runs both phases of the two-phase test and compares their results If success_change is True, success requires some files to be different
Submodules -
CIME.SystemTests.tsc module
+CIME.SystemTests.tsc module
Solution reproducibility test based on time-step convergence The CESM/ACME model’s multi-instance capability is used to conduct an ensemble @@ -1205,11 +1211,11 @@
Submodules
- -class CIME.SystemTests.tsc.TSC(case, **kwargs)[source]
+class CIME.SystemTests.tsc.TSC(case, **kwargs)[source]Bases:
SystemTestsCommon- -build_phase(sharedlib_only=False, model_only=False)[source] +build_phase(sharedlib_only=False, model_only=False)[source]
This is the default build phase implementation, it just does an individual build. This is the subclass’ extension point if they need to define a custom build phase.
@@ -1218,7 +1224,7 @@Submodules
- -run_phase()[source]
+run_phase()[source]This is the default run phase implementation, it just does an individual run. This is the subclass’ extension point if they need to define a custom run phase.
PLEASE THROW AN EXCEPTION ON FAIL
@@ -1228,7 +1234,7 @@Submodules -
Module contents
+Module contents
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package +
- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package @@ -138,16 +139,16 @@
- -CIME.SystemTests.test_utils.user_nl_utils.append_to_user_nl_files(caseroot, component, contents)[source] +CIME.SystemTests.test_utils.user_nl_utils.append_to_user_nl_files(caseroot, component, contents)[source]
Append the string(s) given by ‘contents’ to the end of each user_nl file for the given component (there may be multiple such user_nl files in the case of a multi-instance test).
@@ -171,7 +172,7 @@Submodules -
Module contents
+Module contents
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package +
- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package @@ -137,46 +138,46 @@
- -CIME.Tools.generate_cylc_workflow.cylc_batch_job_template(job, jobname, case, ensemble)[source] +CIME.Tools.generate_cylc_workflow.cylc_batch_job_template(job, jobname, case, ensemble)[source]
- -CIME.Tools.generate_cylc_workflow.cylc_get_case_path_string(case, ensemble)[source] +CIME.Tools.generate_cylc_workflow.cylc_get_case_path_string(case, ensemble)[source]
- -CIME.Tools.generate_cylc_workflow.cylc_get_ensemble_first_and_last(case, ensemble)[source] +CIME.Tools.generate_cylc_workflow.cylc_get_ensemble_first_and_last(case, ensemble)[source]
- -CIME.Tools.standard_script_setup.check_minimum_python_version(major, minor)[source] +CIME.Tools.standard_script_setup.check_minimum_python_version(major, minor)[source]
Check your python version.
>>> check_minimum_python_version(sys.version_info[0], sys.version_info[1]) >>> @@ -186,21 +187,21 @@
Submodules -
CIME.Tools.testreporter module
+CIME.Tools.testreporter module
Simple script to populate CESM test database with test results.
- -CIME.Tools.testreporter.get_testreporter_xml(testroot, testid, tagname, testtype)[source] +CIME.Tools.testreporter.get_testreporter_xml(testroot, testid, tagname, testtype)[source]
- -CIME.Tools.testreporter.parse_command_line(args)[source] +CIME.Tools.testreporter.parse_command_line(args)[source]
- diff --git a/versions/master/html/CIME_api/CIME.XML.html b/versions/master/html/CIME_api/CIME.XML.html index d73bda2af51..3f2c69c1f92 100644 --- a/versions/master/html/CIME_api/CIME.XML.html +++ b/versions/master/html/CIME_api/CIME.XML.html @@ -12,16 +12,16 @@ - - - - - + + + + + - + @@ -66,6 +66,7 @@Module contents
+Module contents
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package
+- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package
@@ -137,72 +138,72 @@- CIME.XML package
+CIME.XML package
- Submodules
+Submodules
- CIME.XML.archive module
+CIME.XML.archive module
Interface to the archive.xml file. This class inherits from GenericXML.py
- -class CIME.XML.archive.Archive(infile=None, files=None)[source] +class CIME.XML.archive.Archive(infile=None, files=None)[source]
Bases:
ArchiveBase
- CIME.XML.archive_base module
+CIME.XML.archive_base module
Base class for archive files. This class inherits from generic_xml.py
- -class CIME.XML.archive_base.ArchiveBase(infile=None, schema=None, root_name_override=None, root_attrib_override=None, read_only=True)[source] +class CIME.XML.archive_base.ArchiveBase(infile=None, schema=None, root_name_override=None, root_attrib_override=None, read_only=True)[source]
Bases:
GenericXML- -exclude_testing(compname)[source] +exclude_testing(compname)[source]
Checks if component should be excluded from testing.
- -get_all_hist_files(casename, model, from_dir, suffix='', ref_case=None)[source] +get_all_hist_files(casename, model, from_dir, suffix='', ref_case=None)[source]
gets all history files in directory from_dir with suffix (if provided) ignores files with ref_case in the name if ref_case is provided
- -get_entry(compname)[source] +get_entry(compname)[source]
Returns an xml node corresponding to compname in comp_archive_spec
- -get_entry_value(name, archive_entry)[source] +get_entry_value(name, archive_entry)[source]
get the xml text associated with name under root archive_entry returns None if no entry is found, expects only one entry
- -get_hist_file_ext_regexes(archive_entry)[source] +get_hist_file_ext_regexes(archive_entry)[source]
get the xml text associated with each of the hist_file_ext_regex entries based at root archive_entry (root is based on component name) returns a list of text entries or @@ -211,7 +212,7 @@
Submodules
- -get_hist_file_extensions(archive_entry)[source]
+get_hist_file_extensions(archive_entry)[source]get the xml text associated with each of the hist_file_extensions based at root archive_entry (root is based on component name) returns a list of text entries or @@ -220,13 +221,13 @@
Submodules
- -get_latest_hist_files(casename, model, from_dir, suffix='', ref_case=None)[source]
+get_latest_hist_files(casename, model, from_dir, suffix='', ref_case=None)[source]get the most recent history files in directory from_dir with suffix if provided
- -get_rest_file_extensions(archive_entry)[source] +get_rest_file_extensions(archive_entry)[source]
get the xml text associated with each of the rest_file_extensions based at root archive_entry (root is based on component name) returns a list of text entries or @@ -237,42 +238,42 @@
Submodules -
CIME.XML.batch module
+CIME.XML.batch module
Interface to the config_batch.xml file. This class inherits from GenericXML.py
The batch_system type=”foo” blocks define most things. Machine-specific overrides can be defined by providing a batch_system MACH=”mach” block.
- -class CIME.XML.batch.Batch(batch_system=None, machine=None, infile=None, files=None, extra_machines_dir=None)[source] +class CIME.XML.batch.Batch(batch_system=None, machine=None, infile=None, files=None, extra_machines_dir=None)[source]
Bases:
GenericXML- -get_batch_jobs()[source] +get_batch_jobs()[source]
Return a list of jobs with the first element the name of the case script and the second a dict of qualifiers for the job
- -get_optional_batch_node(nodename, attributes=None)[source] +get_optional_batch_node(nodename, attributes=None)[source]
Return data on a node for a batch system
- -get_value(name, attribute=None, resolved=True, subgroup=None)[source] +get_value(name, attribute=None, resolved=True, subgroup=None)[source]
Get Value of fields in the config_batch.xml file
- -set_batch_system(batch_system, machine=None)[source] +set_batch_system(batch_system, machine=None)[source]
Sets the batch system block in the Batch object
Submodules -
CIME.XML.component module
+CIME.XML.component module
Interface to the config_component.xml files. This class inherits from EntryID.py
- -class CIME.XML.component.Component(infile, comp_class)[source] +class CIME.XML.component.Component(infile, comp_class)[source]
Bases:
EntryID- -get_valid_model_components()[source] +get_valid_model_components()[source]
return a list of all possible valid generic (e.g. atm, clm, …) model components from the entries in the model CONFIG_CPL_FILE
- -get_value(name, attribute=None, resolved=False, subgroup=None)[source] +get_value(name, attribute=None, resolved=False, subgroup=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches
@@ -313,13 +314,13 @@Submodules
- -print_values()[source]
+print_values()[source]print values for help and description in target config_component.xml file
- -return_values()[source] +return_values()[source]
return a list of hashes from target config_component.xml file This routine is used by external tools in https://github.com/NCAR/CESM_xml2html
Submodules -
CIME.XML.compsets module
+CIME.XML.compsets module
Common interface to XML files which follow the compsets format,
- -class CIME.XML.compsets.Compsets(infile=None, files=None)[source] +class CIME.XML.compsets.Compsets(infile=None, files=None)[source]
Bases:
GenericXML- -get_compset_match(name)[source] +get_compset_match(name)[source]
science support is used in cesm to determine if this compset and grid is scientifically supported. science_support is returned as an array of grids for this compset
- -get_compset_var_settings(compset, grid)[source] +get_compset_var_settings(compset, grid)[source]
Variables can be set in config_compsets.xml in entry id settings with compset and grid attributes find and return id value pairs here
- CIME.XML.entry_id module
+CIME.XML.entry_id module
Common interface to XML files which follow the entry id format, this is an abstract class and is expected to be used by other XML interface modules and not directly.
- -class CIME.XML.entry_id.EntryID(infile=None, schema=None, read_only=True)[source] +class CIME.XML.entry_id.EntryID(infile=None, schema=None, read_only=True)[source]
Bases:
GenericXML- -add_elements_by_group(srcobj, attributes=None, infile=None)[source] +add_elements_by_group(srcobj, attributes=None, infile=None)[source]
Add elements from srcobj to self under the appropriate group element, entries to be added must have a child element <file> with value “infile”
@@ -387,74 +388,74 @@Submodules
- -check_if_comp_var(vid, attribute=None, node=None)[source]
+check_if_comp_var(vid, attribute=None, node=None)[source]
- -compare_xml(other, root=None, otherroot=None)[source] +compare_xml(other, root=None, otherroot=None)[source]
- -get_default_value(node, attributes=None)[source] +get_default_value(node, attributes=None)[source]
Set the value of an entry to the default value for that entry
- -get_elements_from_child_content(childname, childcontent)[source] +get_elements_from_child_content(childname, childcontent)[source]
- -get_node_element_info(vid, element_name)[source] +get_node_element_info(vid, element_name)[source]
- -get_valid_value_string(node, value, vid=None, ignore_type=False)[source] +get_valid_value_string(node, value, vid=None, ignore_type=False)[source]
- -get_value(vid, attribute=None, resolved=True, subgroup=None)[source] +get_value(vid, attribute=None, resolved=True, subgroup=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches
@@ -462,7 +463,7 @@Submodules
- -get_value_match(vid, attributes=None, exact_match=False, entry_node=None, replacement_for_none=None)[source]
+get_value_match(vid, attributes=None, exact_match=False, entry_node=None, replacement_for_none=None)[source]Handle this case: <entry id …>
@@ -483,7 +484,7 @@
Submodules
- -get_values(vid, attribute=None, resolved=True, subgroup=None)[source]
+get_values(vid, attribute=None, resolved=True, subgroup=None)[source]Same functionality as get_value but it returns a list, if the value in xml contains commas the list have multiple elements split on commas
@@ -491,22 +492,22 @@Submodules
- -overwrite_existing_entries()[source]
+overwrite_existing_entries()[source]
- -set_value(vid, value, subgroup=None, ignore_type=False)[source] +set_value(vid, value, subgroup=None, ignore_type=False)[source]
Set the value of an entry-id field to value Returns the value or None if not found subgroup is ignored in the general routine and applied in specific methods
@@ -516,61 +517,61 @@Submodules -
CIME.XML.env_archive module
+CIME.XML.env_archive module
Interface to the env_archive.xml file. This class inherits from EnvBase
- CIME.XML.env_base module
+CIME.XML.env_base module
Base class for env files. This class inherits from EntryID.py
- -class CIME.XML.env_base.EnvBase(case_root, infile, schema=None, read_only=False)[source] +class CIME.XML.env_base.EnvBase(case_root, infile, schema=None, read_only=False)[source]
Bases:
EntryID- -check_if_comp_var(vid, attribute=None, node=None)[source] +check_if_comp_var(vid, attribute=None, node=None)[source]
- -cleanupnode(node)[source] +cleanupnode(node)[source]
Remove the <group>, <file>, <values> and <value> childnodes from node
- -get_children(name=None, attributes=None, root=None)[source] +get_children(name=None, attributes=None, root=None)[source]
This is the critical function, its interface and performance are crucial.
You can specify attributes={key:None} if you want to select children with the key attribute but you don’t care what its value is.
@@ -578,12 +579,12 @@Submodules
- -get_nodes_by_id(varid)[source]
+get_nodes_by_id(varid)[source]
- -get_value(vid, attribute=None, resolved=True, subgroup=None)[source] +get_value(vid, attribute=None, resolved=True, subgroup=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches
@@ -591,17 +592,17 @@Submodules
- -scan_children(nodename, attributes=None, root=None)[source]
+scan_children(nodename, attributes=None, root=None)[source]
- -set_value(vid, value, subgroup=None, ignore_type=False)[source] +set_value(vid, value, subgroup=None, ignore_type=False)[source]
Set the value of an entry-id field to value Returns the value or None if not found subgroup is ignored in the general routine and applied in specific methods
@@ -611,56 +612,56 @@Submodules -
CIME.XML.env_batch module
+CIME.XML.env_batch module
Interface to the env_batch.xml file. This class inherits from EnvBase
- -class CIME.XML.env_batch.EnvBatch(case_root=None, infile='env_batch.xml', read_only=False)[source] +class CIME.XML.env_batch.EnvBatch(case_root=None, infile='env_batch.xml', read_only=False)[source]
Bases:
EnvBase- -cleanupnode(node)[source] +cleanupnode(node)[source]
Remove the <group>, <file>, <values> and <value> childnodes from node
- -get_batch_directives(case, job, overrides=None, output_format='default')[source] +get_batch_directives(case, job, overrides=None, output_format='default')[source]
- -get_children(name=None, attributes=None, root=None)[source] +get_children(name=None, attributes=None, root=None)[source]
This is the critical function, its interface and performance are crucial.
You can specify attributes={key:None} if you want to select children with the key attribute but you don’t care what its value is.
@@ -668,97 +669,97 @@Submodules
- -get_default_queue()[source]
+get_default_queue()[source]
- -get_queue_specs(qnode)[source] +get_queue_specs(qnode)[source]
Get queue specifications from node.
Returns (nodemin, nodemax, jobname, walltimemax, jobmin, jobmax, is_strict)
- -get_submit_args(case, job, resolve=True)[source] +get_submit_args(case, job, resolve=True)[source]
return a list of touples (flag, name)
- -get_value(item, attribute=None, resolved=True, subgroup=None)[source] +get_value(item, attribute=None, resolved=True, subgroup=None)[source]
Must default subgroup to something in order to provide single return value
- -make_batch_script(input_template, job, case, outfile=None)[source] +make_batch_script(input_template, job, case, outfile=None)[source]
- -queue_meets_spec(queue, num_nodes, num_tasks, walltime=None, job=None)[source] +queue_meets_spec(queue, num_nodes, num_tasks, walltime=None, job=None)[source]
- -select_best_queue(num_nodes, num_tasks, name=None, walltime=None, job=None)[source] +select_best_queue(num_nodes, num_tasks, name=None, walltime=None, job=None)[source]
- -set_batch_system(batchobj, batch_system_type=None)[source] +set_batch_system(batchobj, batch_system_type=None)[source]
- -set_value(item, value, subgroup=None, ignore_type=False)[source] +set_value(item, value, subgroup=None, ignore_type=False)[source]
Override the entry_id set_value function with some special cases for this class
- -submit_jobs(case, no_batch=False, job=None, user_prereq=None, skip_pnl=False, allow_fail=False, resubmit_immediate=False, mail_user=None, mail_type=None, batch_args=None, dry_run=False, workflow=True)[source] +submit_jobs(case, no_batch=False, job=None, user_prereq=None, skip_pnl=False, allow_fail=False, resubmit_immediate=False, mail_user=None, mail_type=None, batch_args=None, dry_run=False, workflow=True)[source]
no_batch indicates that the jobs should be run directly rather that submitted to a queueing system job is the first job in the workflow sequence to start user_prereq is a batch system prerequisite as requested by the user @@ -773,17 +774,41 @@
Submodules +
- +CIME.XML.env_batch.get_job_deps(dependency, depid, prev_job=None, user_prereq=None)[source]
+Gather list of job batch ids that a job depends on.
++ +Parameters
+-
+
- dependencystr
List of dependent job names.
+
+- depiddict
Lookup where keys are job names and values are the batch id.
+
+- user_prereqstr
User requested dependency.
+
+
+ +Returns
+-
+
- list
List of batch ids that job depends on.
+
+
- CIME.XML.env_build module
+CIME.XML.env_build module
Interface to the env_build.xml file. This class inherits from EnvBase
- -class CIME.XML.env_build.EnvBuild(case_root=None, infile='env_build.xml', components=None, read_only=False)[source] +class CIME.XML.env_build.EnvBuild(case_root=None, infile='env_build.xml', components=None, read_only=False)[source]
Bases:
EnvBase- -set_value(vid, value, subgroup=None, ignore_type=False)[source] +set_value(vid, value, subgroup=None, ignore_type=False)[source]
Set the value of an entry-id field to value Returns the value or None if not found subgroup is ignored in the general routine and applied in specific methods
@@ -793,57 +818,57 @@Submodules -
CIME.XML.env_case module
+CIME.XML.env_case module
Interface to the env_case.xml file. This class inherits from EnvBase
- CIME.XML.env_mach_pes module
+CIME.XML.env_mach_pes module
Interface to the env_mach_pes.xml file. This class inherits from EntryID
- -class CIME.XML.env_mach_pes.EnvMachPes(case_root=None, infile='env_mach_pes.xml', components=None, read_only=False, comp_interface='mct')[source] +class CIME.XML.env_mach_pes.EnvMachPes(case_root=None, infile='env_mach_pes.xml', components=None, read_only=False, comp_interface='mct')[source]
Bases:
EnvBase- -get_max_thread_count(comp_classes)[source] +get_max_thread_count(comp_classes)[source]
Find the maximum number of openmp threads for any component in the case
- -get_tasks_per_node(total_tasks, max_thread_count)[source] +get_tasks_per_node(total_tasks, max_thread_count)[source]
- -get_total_nodes(total_tasks, max_thread_count)[source] +get_total_nodes(total_tasks, max_thread_count)[source]
Return (num_active_nodes, num_spare_nodes)
- -get_total_tasks(comp_classes, async_interface=False)[source] +get_total_tasks(comp_classes, async_interface=False)[source]
- -get_value(vid, attribute=None, resolved=True, subgroup=None, max_mpitasks_per_node=None, max_cputasks_per_gpu_node=None, ngpus_per_node=None)[source] +get_value(vid, attribute=None, resolved=True, subgroup=None, max_mpitasks_per_node=None, max_cputasks_per_gpu_node=None, ngpus_per_node=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches
@@ -851,7 +876,7 @@Submodules
- -set_value(vid, value, subgroup=None, ignore_type=False)[source]
+set_value(vid, value, subgroup=None, ignore_type=False)[source]Set the value of an entry-id field to value Returns the value or None if not found subgroup is ignored in the general routine and applied in specific methods
@@ -861,15 +886,15 @@Submodules -
CIME.XML.env_mach_specific module
+CIME.XML.env_mach_specific module
Interface to the env_mach_specific.xml file. This class inherits from EnvBase
- -class CIME.XML.env_mach_specific.EnvMachSpecific(caseroot=None, infile='env_mach_specific.xml', components=None, unit_testing=False, read_only=False, standalone_configure=False, comp_interface=None)[source] +class CIME.XML.env_mach_specific.EnvMachSpecific(caseroot=None, infile='env_mach_specific.xml', components=None, unit_testing=False, read_only=False, standalone_configure=False, comp_interface=None)[source]
Bases:
EnvBase- -allow_error()[source] +allow_error()[source]
Return True if stderr output from module commands should be assumed to be an error. Default False. This is necessary since implementations of environment modules are highlty variable and some systems produce @@ -878,60 +903,60 @@
Submodules
- -get_aprun_args(case, attribs, job, overrides=None)[source]
+get_aprun_args(case, attribs, job, overrides=None)[source]
- -get_module_system_type()[source] +get_module_system_type()[source]
Return the module system used on this machine
- -get_mpirun(case, attribs, job, exe_only=False, overrides=None)[source] +get_mpirun(case, attribs, job, exe_only=False, overrides=None)[source]
Find best match, return (executable, {arg_name : text})
- -load_env(case, force_method=None, job=None, verbose=False)[source] +load_env(case, force_method=None, job=None, verbose=False)[source]
Should only be called by case.load_env
- -make_env_mach_specific_file(shell, case, output_dir='')[source] +make_env_mach_specific_file(shell, case, output_dir='')[source]
Writes .env_mach_specific.sh or .env_mach_specific.csh
Args: shell: string - ‘sh’ or ‘csh’ @@ -941,14 +966,14 @@
Submodules
- -populate(machobj, attributes=None)[source]
+populate(machobj, attributes=None)[source]Add entries to the file using information from a Machines object. mpilib must match attributes if set
- -save_all_env_info(filename)[source] +save_all_env_info(filename)[source]
Get a string representation of all current environment info and save it to file.
Submodules -
CIME.XML.env_run module
+CIME.XML.env_run module
Interface to the env_run.xml file. This class inherits from EnvBase
- -class CIME.XML.env_run.EnvRun(case_root=None, infile='env_run.xml', components=None, read_only=False)[source] +class CIME.XML.env_run.EnvRun(case_root=None, infile='env_run.xml', components=None, read_only=False)[source]
Bases:
EnvBase- -get_value(vid, attribute=None, resolved=True, subgroup=None)[source] +get_value(vid, attribute=None, resolved=True, subgroup=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches. Special case for pio variables when PIO_ASYNC_INTERFACE is True.
@@ -973,7 +998,7 @@Submodules
- -set_value(vid, value, subgroup=None, ignore_type=False)[source]
+set_value(vid, value, subgroup=None, ignore_type=False)[source]Set the value of an entry-id field to value Returns the value or None if not found subgroup is ignored in the general routine and applied in specific methods
@@ -983,41 +1008,41 @@Submodules -
CIME.XML.env_test module
+CIME.XML.env_test module
Interface to the env_test.xml file. This class inherits from EnvBase
- -class CIME.XML.env_test.EnvTest(case_root=None, infile='env_test.xml', components=None, read_only=False)[source] +class CIME.XML.env_test.EnvTest(case_root=None, infile='env_test.xml', components=None, read_only=False)[source]
Bases:
EnvBase- -get_value(vid, attribute=None, resolved=True, subgroup=None)[source] +get_value(vid, attribute=None, resolved=True, subgroup=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches
@@ -1025,12 +1050,12 @@Submodules
- -run_phase_get_clone_name(phase)[source]
+run_phase_get_clone_name(phase)[source]
- -set_initial_values(case)[source] +set_initial_values(case)[source]
The values to initialize a test are defined in env_test.xml copy them to the appropriate case env files to initialize a test ignore fields set in the BUILD and RUN clauses, they are set in @@ -1039,14 +1064,14 @@
Submodules
- -set_test_parameter(name, value)[source]
+set_test_parameter(name, value)[source]If a node already exists update the value otherwise create a node and initialize it to value
- -set_value(vid, value, subgroup=None, ignore_type=False)[source] +set_value(vid, value, subgroup=None, ignore_type=False)[source]
check if vid is in test section of file
Submodules -
CIME.XML.env_workflow module
+CIME.XML.env_workflow module
Interface to the env_workflow.xml file. This class inherits from EnvBase
- -class CIME.XML.env_workflow.EnvWorkflow(case_root=None, infile='env_workflow.xml', read_only=False)[source] +class CIME.XML.env_workflow.EnvWorkflow(case_root=None, infile='env_workflow.xml', read_only=False)[source]
Bases:
EnvBase- -get_children(name=None, attributes=None, root=None)[source] +get_children(name=None, attributes=None, root=None)[source]
This is the critical function, its interface and performance are crucial.
You can specify attributes={key:None} if you want to select children with the key attribute but you don’t care what its value is.
@@ -1075,28 +1100,28 @@Submodules
- -get_job_specs(case, job)[source]
+get_job_specs(case, job)[source]
- -get_value(item, attribute=None, resolved=True, subgroup='PRIMARY')[source] +get_value(item, attribute=None, resolved=True, subgroup='PRIMARY')[source]
Must default subgroup to something in order to provide single return value
- -set_value(item, value, subgroup=None, ignore_type=False)[source] +set_value(item, value, subgroup=None, ignore_type=False)[source]
Override the entry_id set_value function with some special cases for this class
Submodules -
CIME.XML.expected_fails_file module
+CIME.XML.expected_fails_file module
Interface to an expected failure xml file
Here is an example:
<?xml version= “1.0”?>
@@ -1163,11 +1188,11 @@Submodules
- -class CIME.XML.expected_fails_file.ExpectedFailsFile(infile)[source]
+class CIME.XML.expected_fails_file.ExpectedFailsFile(infile)[source]Bases:
GenericXML- -get_expected_fails()[source] +get_expected_fails()[source]
Returns a dictionary of ExpectedFails objects, where the keys are test names
Submodules -
CIME.XML.files module
+CIME.XML.files module
Interface to the config_files.xml file. This class inherits from EntryID.py
- -class CIME.XML.files.Files(comp_interface=None)[source] +class CIME.XML.files.Files(comp_interface=None)[source]
Bases:
EntryID- -get_value(vid, attribute=None, resolved=True, subgroup=None)[source] +get_value(vid, attribute=None, resolved=True, subgroup=None)[source]
Get a value for entry with id attribute vid. or from the values field if the attribute argument is provided and matches
@@ -1201,7 +1226,7 @@Submodules
- -set_value(vid, value, subgroup=None, ignore_type=False)[source]
+set_value(vid, value, subgroup=None, ignore_type=False)[source]Set the value of an entry-id field to value Returns the value or None if not found subgroup is ignored in the general routine and applied in specific methods
@@ -1211,32 +1236,32 @@Submodules -
CIME.XML.generic_xml module
+CIME.XML.generic_xml module
Common interface to XML files, this is an abstract class and is expected to be used by other XML interface modules and not directly.
- -class CIME.XML.generic_xml.GenericXML(infile=None, schema=None, root_name_override=None, root_attrib_override=None, read_only=True)[source] +class CIME.XML.generic_xml.GenericXML(infile=None, schema=None, root_name_override=None, root_attrib_override=None, read_only=True)[source]
Bases:
object- -class CacheEntry(tree, root, modtime) +class CacheEntry(tree, root, modtime)
Bases:
@@ -1244,49 +1269,49 @@tupleSubmodules
- -DISABLE_CACHING = False
+DISABLE_CACHING = False
- -add_child(node, root=None, position=None)[source] +add_child(node, root=None, position=None)[source]
Add element node to self at root
- -check_timestamp()[source] +check_timestamp()[source]
Returns True if timestamp matches what is expected
- -get_child(name=None, attributes=None, root=None, err_msg=None)[source] +get_child(name=None, attributes=None, root=None, err_msg=None)[source]
- -get_children(name=None, attributes=None, root=None)[source] +get_children(name=None, attributes=None, root=None)[source]
This is the critical function, its interface and performance are crucial.
You can specify attributes={key:None} if you want to select children with the key attribute but you don’t care what its value is.
@@ -1294,27 +1319,27 @@Submodules
- -get_element_text(element_name, attributes=None, root=None)[source]
+get_element_text(element_name, attributes=None, root=None)[source]
- -get_optional_child(name=None, attributes=None, root=None, err_msg=None)[source] +get_optional_child(name=None, attributes=None, root=None, err_msg=None)[source]
- -get_resolved_value(raw_value, allow_unresolved_envvars=False)[source] +get_resolved_value(raw_value, allow_unresolved_envvars=False)[source]
A value in the xml file may contain references to other xml variables or to environment variables. These are refered to in the perl style with $name and $ENV{name}.
@@ -1335,148 +1360,148 @@Submodules
- -get_value(item, attribute=None, resolved=True, subgroup=None)[source]
+get_value(item, attribute=None, resolved=True, subgroup=None)[source]get_value is expected to be defined by the derived classes, if you get here the value was not found in the class.
- -get_values(vid, attribute=None, resolved=True, subgroup=None)[source] +get_values(vid, attribute=None, resolved=True, subgroup=None)[source]
- -lock()[source] +lock()[source]
A subclass is doing caching, we need to lock the tree structure in order to avoid invalidating cache.
- -make_child(name, attributes=None, root=None, text=None)[source] +make_child(name, attributes=None, root=None, text=None)[source]
- -make_child_comment(root=None, text=None)[source] +make_child_comment(root=None, text=None)[source]
- -read(infile, schema=None)[source] +read(infile, schema=None)[source]
Read and parse an xml file into the object
- -scan_child(nodename, attributes=None, root=None)[source] +scan_child(nodename, attributes=None, root=None)[source]
Get an xml element matching nodename with optional attributes.
Error unless exactly one match.
- -scan_children(nodename, attributes=None, root=None)[source] +scan_children(nodename, attributes=None, root=None)[source]
- -scan_optional_child(nodename, attributes=None, root=None)[source] +scan_optional_child(nodename, attributes=None, root=None)[source]
Get an xml element matching nodename with optional attributes.
Return None if no match.
- -set_element_text(element_name, new_text, attributes=None, root=None)[source] +set_element_text(element_name, new_text, attributes=None, root=None)[source]
- -set_value(vid, value, subgroup=None, ignore_type=True)[source] +set_value(vid, value, subgroup=None, ignore_type=True)[source]
ignore_type is not used in this flavor
- -to_string(node, method='xml', encoding='us-ascii')[source] +to_string(node, method='xml', encoding='us-ascii')[source]
- -validate_xml_file(filename, schema)[source] +validate_xml_file(filename, schema)[source]
validate an XML file against a provided schema file using pylint
- -write(outfile=None, force_write=False)[source] +write(outfile=None, force_write=False)[source]
Write an xml file from data in self
Submodules -
CIME.XML.grids module
+CIME.XML.grids module
Common interface to XML files which follow the grids format, This is not an abstract class - but inherits from the abstact class GenericXML
- -class CIME.XML.grids.Grids(infile=None, files=None, comp_interface=None)[source] +class CIME.XML.grids.Grids(infile=None, files=None, comp_interface=None)[source]
Bases:
GenericXML
- CIME.XML.headers module
+CIME.XML.headers module
Interface to the config_headers.xml file. This class inherits from EntryID.py
- CIME.XML.inputdata module
+CIME.XML.inputdata module
Interface to the config_inputdata.xml file. This class inherits from GenericXML.py
- CIME.XML.machines module
+CIME.XML.machines module
Interface to the config_machines.xml file. This class inherits from GenericXML.py
- -class CIME.XML.machines.Machines(infile=None, files=None, machine=None, extra_machines_dir=None)[source] +class CIME.XML.machines.Machines(infile=None, files=None, machine=None, extra_machines_dir=None)[source]
Bases:
GenericXML- -get_child(name=None, attributes=None, root=None, err_msg=None)[source] +get_child(name=None, attributes=None, root=None, err_msg=None)[source]
- -get_default_MPIlib(attributes=None)[source] +get_default_MPIlib(attributes=None)[source]
Get the MPILIB to use from the list of MPILIBS
- -get_default_compiler()[source] +get_default_compiler()[source]
Get the compiler to use from the list of COMPILERS
- -get_field_from_list(listname, reqval=None, attributes=None)[source] +get_field_from_list(listname, reqval=None, attributes=None)[source]
Some of the fields have lists of valid values in the xml, parse these lists and return the first value if reqval is not provided and reqval if it is a valid setting for the machine
@@ -1575,85 +1600,85 @@Submodules
- -get_first_child_nodes(nodename)[source]
+get_first_child_nodes(nodename)[source]Return the names of all the child nodes for the target machine
- -get_node_names()[source] +get_node_names()[source]
Return the names of all the child nodes for the target machine
- -get_value(name, attributes=None, resolved=True, subgroup=None)[source] +get_value(name, attributes=None, resolved=True, subgroup=None)[source]
Get Value of fields in the config_machines.xml file
- -is_valid_MPIlib(mpilib, attributes=None)[source] +is_valid_MPIlib(mpilib, attributes=None)[source]
Check the MPILIB is valid for the current machine
- -is_valid_compiler(compiler)[source] +is_valid_compiler(compiler)[source]
Check the compiler is valid for the current machine
- -list_available_machines()[source] +list_available_machines()[source]
Return a list of machines defined for a given CIME_MODEL
- -probe_machine_name(warn=True)[source] +probe_machine_name(warn=True)[source]
Find a matching regular expression for hostname in the NODENAME_REGEX field in the file. First match wins.
- -return_values()[source] +return_values()[source]
return a dictionary of machine info This routine is used by external tools in https://github.com/NCAR/CESM_xml2html
- -set_machine(machine)[source] +set_machine(machine)[source]
Sets the machine block in the Machines object
>>> machobj = Machines(machine="melvin") >>> machobj.get_machine_name() @@ -1668,7 +1693,7 @@
Submodules
- -set_value(vid, value, subgroup=None, ignore_type=True)[source]
+set_value(vid, value, subgroup=None, ignore_type=True)[source]ignore_type is not used in this flavor
Submodules -
CIME.XML.namelist_definition module
+CIME.XML.namelist_definition module
Interface to namelist_definition.xml.
This module contains only one class, NamelistDefinition, inheriting from EntryID.
- -class CIME.XML.namelist_definition.CaseInsensitiveDict(data)[source] +class CIME.XML.namelist_definition.CaseInsensitiveDict(data)[source]
Bases:
dictBasic case insensitive dict with strings only keys. From https://stackoverflow.com/a/27890005
- -class CIME.XML.namelist_definition.NamelistDefinition(infile, files=None)[source] +class CIME.XML.namelist_definition.NamelistDefinition(infile, files=None)[source]
Bases:
EntryIDClass representing variable definitions for a namelist. This class inherits from EntryID, and supports most inherited methods; @@ -1712,12 +1737,12 @@
Submodules
- -add_attributes(attributes)[source]
+add_attributes(attributes)[source]
- -dict_to_namelist(dict_, filename=None)[source] +dict_to_namelist(dict_, filename=None)[source]
Converts a dictionary of name-value pairs to a Namelist.
The input is assumed to be similar to the output of parse when groupless=True is set. This function uses the namelist definition file @@ -1729,13 +1754,13 @@
Submodules
- -get_attributes()[source]
+get_attributes()[source]Return this object’s attributes dictionary
- -get_default_value(item, attribute=None)[source] +get_default_value(item, attribute=None)[source]
Return the default value for the variable named item.
The return value is a list of strings corresponding to the comma-separated list of entries for the value (length 1 for scalars). If @@ -1744,32 +1769,32 @@
Submodules
- -get_entry_nodes()[source]
+get_entry_nodes()[source]
- -get_value_match(vid, attributes=None, exact_match=True, entry_node=None)[source] +get_value_match(vid, attributes=None, exact_match=True, entry_node=None)[source]
Return the default value for the variable named vid.
The return value is a list of strings corresponding to the comma-separated list of entries for the value (length 1 for scalars). If @@ -1778,7 +1803,7 @@
Submodules
- -is_valid_value(name, value)[source]
+is_valid_value(name, value)[source]Determine whether a value is valid for the named variable.
The value argument must be a list of strings formatted as they would appear in the namelist (even for scalar variables, in which case the @@ -1787,30 +1812,30 @@
Submodules
- -rename_group(oldgroup, newgroup)[source]
+rename_group(oldgroup, newgroup)[source]
- -set_nodes(skip_groups=None)[source] +set_nodes(skip_groups=None)[source]
populates the object data types for all nodes that are not part of the skip_groups array returns nodes that do not have attributes of skip_default_entry or per_stream_entry
- -set_value(vid, value, subgroup=None, ignore_type=True)[source] +set_value(vid, value, subgroup=None, ignore_type=True)[source]
This function is not implemented.
- -split_type_string(name)[source] +split_type_string(name)[source]
Split a ‘type’ attribute string into its component parts.
The name argument is the variable name. This is used for error reporting purposes.
@@ -1821,7 +1846,7 @@Submodules
- -validate(namelist, filename=None)[source]
+validate(namelist, filename=None)[source]Validate a namelist object against this definition.
The optional filename argument can be used to assist in error reporting when the namelist comes from a specific, known file.
@@ -1831,54 +1856,54 @@Submodules -
CIME.XML.pes module
+CIME.XML.pes module
Interface to the config_pes.xml file. This class inherits from GenericXML.py
- -class CIME.XML.pes.Pes(infile, files=None)[source] +class CIME.XML.pes.Pes(infile, files=None)[source]
Bases:
GenericXML
- CIME.XML.pio module
+CIME.XML.pio module
Class for config_pio files . This class inherits from EntryID.py
- CIME.XML.standard_module_setup module
+CIME.XML.standard_module_setup module
- CIME.XML.stream module
+CIME.XML.stream module
Interface to the streams.xml style files. This class inherits from GenericXML.py
stream files predate cime and so do not conform to entry id format
- -class CIME.XML.stream.Stream(infile=None, files=None)[source] +class CIME.XML.stream.Stream(infile=None, files=None)[source]
Bases:
GenericXML- -get_value(item, attribute=None, resolved=True, subgroup=None)[source] +get_value(item, attribute=None, resolved=True, subgroup=None)[source]
Get Value of fields in a stream.xml file
Submodules -
CIME.XML.test_reporter module
+CIME.XML.test_reporter module
Interface to the testreporter xml. This class inherits from GenericXML.py
- -class CIME.XML.test_reporter.TestReporter[source] +class CIME.XML.test_reporter.TestReporter[source]
Bases:
GenericXML
- CIME.XML.testlist module
+CIME.XML.testlist module
Interface to the config_files.xml file. This class inherits from generic_xml.py It supports version 2.0 of the testlist.xml file
In version 2 of the file options can be specified to further refine a test or @@ -1954,31 +1979,31 @@
Submodules
- -class CIME.XML.testlist.Testlist(infile, files=None)[source]
+class CIME.XML.testlist.Testlist(infile, files=None)[source]Bases:
GenericXML
- CIME.XML.tests module
+CIME.XML.tests module
Interface to the config_tests.xml file. This class inherits from GenericEntry
- -class CIME.XML.tests.Tests(infile=None, files=None)[source] +class CIME.XML.tests.Tests(infile=None, files=None)[source]
Bases:
GenericXML- -print_values(skip_infrastructure_tests=True)[source] +print_values(skip_infrastructure_tests=True)[source]
Print each test type and its description.
If skip_infrastructure_tests is True, then this does not write information for tests with the attribute @@ -1987,7 +2012,7 @@
Submodules
- -support_single_exe(case)[source]
+support_single_exe(case)[source]Checks if case supports –single-exe.
- Raises:
Exception: If system test cannot be found. @@ -2000,40 +2025,40 @@
Submodules -
CIME.XML.testspec module
+CIME.XML.testspec module
Interface to the testspec.xml file. This class inherits from generic_xml.py
- @@ -2051,7 +2076,7 @@CIME.XML.workflow module
+CIME.XML.workflow module
Interface to the config_workflow.xml file. This class inherits from GenericXML.py
- -class CIME.XML.workflow.Workflow(infile=None, files=None)[source] +class CIME.XML.workflow.Workflow(infile=None, files=None)[source]
Bases:
GenericXML- -get_workflow_jobs(machine, workflowid='default')[source] +get_workflow_jobs(machine, workflowid='default')[source]
Return a list of jobs with the first element the name of the script and the second a dict of qualifiers for the job
Submodules -
Module contents
+Module contents
Submodules Previous - Next + Next
diff --git a/versions/master/html/CIME_api/CIME.baselines.html b/versions/master/html/CIME_api/CIME.baselines.html new file mode 100644 index 00000000000..a7e277ca077 --- /dev/null +++ b/versions/master/html/CIME_api/CIME.baselines.html @@ -0,0 +1,402 @@ + + + + + + +CIME.baselines package — CIME master documentation + + + + + + + + + + + + + + + + + + + ++ + ++ + + + \ No newline at end of file diff --git a/versions/master/html/CIME_api/CIME.build_scripts.html b/versions/master/html/CIME_api/CIME.build_scripts.html index 5cb136a265a..1d9ca146549 100644 --- a/versions/master/html/CIME_api/CIME.build_scripts.html +++ b/versions/master/html/CIME_api/CIME.build_scripts.html @@ -12,17 +12,17 @@ - - - - - + + + + + - + @@ -66,6 +66,7 @@+ + ++++ ++++ ++ +++ + + +CIME.baselines package
++ +Submodules
++ +CIME.baselines.performance module
+-
+
- +CIME.baselines.performance.get_cpl_mem_usage(cpllog)[source] +
Read memory usage from coupler log.
++ +Parameters
+-
+
- cpllogstr
Path to the coupler log.
+
+
+ +Returns
+-
+
- list
Memory usage (data, highwater) as recorded by the coupler or empty list.
+
+
-
+
- +CIME.baselines.performance.get_cpl_throughput(cpllog)[source] +
Reads throuhgput from coupler log.
++ +Parameters
+-
+
- cpllogstr
Path to the coupler log.
+
+
+ +Returns
+-
+
- int or None
Throughput as recorded by the coupler or None
+
+
-
+
- +CIME.baselines.performance.get_latest_cpl_logs(case)[source] +
find and return the latest cpl log file in the run directory
+
-
+
- +CIME.baselines.performance.load_coupler_customization(case)[source] +
Loads customizations from the coupler cime_config directory.
++ +Parameters
+-
+
- caseCIME.case.case.Case
Current case object.
+
+
+ +Returns
+-
+
- CIME.config.Config
Runtime configuration.
+
+
-
+
- +CIME.baselines.performance.perf_compare_memory_baseline(case, baseline_dir=None)[source] +
Compares model highwater memory usage.
++ +Parameters
+-
+
- caseCIME.case.case.Case
Current case object.
+
+- baseline_dirstr
Overrides the baseline directory.
+
+
+ +Returns
+-
+
- below_tolerancebool
Whether the comparison was below the tolerance.
+
+- commentstr
Provides explanation from comparison.
+
+
-
+
- +CIME.baselines.performance.perf_compare_throughput_baseline(case, baseline_dir=None)[source] +
Compares model throughput.
++ +Parameters
+-
+
- caseCIME.case.case.Case
Current case object.
+
+- baseline_dirstr
Overrides the baseline directory.
+
+
+ +Returns
+-
+
- below_tolerancebool
Whether the comparison was below the tolerance.
+
+- commentstr
Provides explanation from comparison.
+
+
-
+
- +CIME.baselines.performance.perf_get_memory(case, config)[source] +
Gets the model memory usage.
+First attempts to use a coupler defined method to retrieve the +models memory usage. If this is not defined then the default +method of parsing the coupler log is used.
++ +Parameters
+-
+
- caseCIME.case.case.Case
Current case object.
+
+
+ +Returns
+-
+
- str or None
Model memory usage.
+
+
-
+
- +CIME.baselines.performance.perf_get_throughput(case, config)[source] +
Gets the model throughput.
+First attempts to use a coupler define method to retrieve the +models throughput. If this is not defined then the default +method of parsing the coupler log is used.
++ +Parameters
+-
+
- caseCIME.case.case.Case
Current case object.
+
+
+ +Returns
+-
+
- str or None
Model throughput.
+
+
-
+
- +CIME.baselines.performance.perf_write_baseline(case, basegen_dir, throughput=True, memory=True)[source] +
Writes the baseline performance files.
++ +Parameters
+-
+
- caseCIME.case.case.Case
Current case object.
+
+- basegen_dirstr
Path to baseline directory.
+
+- throughputbool
If true, write throughput baseline.
+
+- memorybool
If true, write memory baseline.
+
+
-
+
- +CIME.baselines.performance.read_baseline_file(baseline_file)[source] +
Reads value from baseline_file.
+Strips comments and returns the raw content to be decoded.
++ +Parameters
+-
+
- baseline_filestr
Path to the baseline file.
+
+
+ +Returns
+-
+
- str
Value stored in baseline file without comments.
+
+
+ +Module contents
+- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package
+- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package
@@ -137,9 +138,9 @@diff --git a/versions/master/html/CIME_api/CIME.case.html b/versions/master/html/CIME_api/CIME.case.html index 5886886780d..d91b421eec4 100644 --- a/versions/master/html/CIME_api/CIME.case.html +++ b/versions/master/html/CIME_api/CIME.case.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@- @@ -147,7 +148,7 @@CIME.build_scripts package
+CIME.build_scripts package
- Module contents
+Module contents
CIME.build_scripts package - Previous + Previous Next
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package
+- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package
@@ -137,18 +138,18 @@- diff --git a/versions/master/html/CIME_api/CIME.data.config.html b/versions/master/html/CIME_api/CIME.data.config.html index 49ecef2c2b8..365d3a8cf96 100644 --- a/versions/master/html/CIME_api/CIME.data.config.html +++ b/versions/master/html/CIME_api/CIME.data.config.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@CIME.case package
+CIME.case package
- Submodules
+Submodules
- CIME.case.case module
+CIME.case.case module
Wrapper around all env XML for a case.
All interaction with and between the module files in XML/ takes place through the Case module.
- -class CIME.case.case.Case(case_root=None, read_only=True, record=False, non_local=False)[source] +class CIME.case.case.Case(case_root=None, read_only=True, record=False, non_local=False)[source]
Bases:
objecthttps://github.com/ESMCI/cime/wiki/Developers-Introduction The Case class is the heart of the CIME Case Control system. All @@ -173,7 +174,7 @@
Submodules
- -apply_user_mods(user_mods_dirs=None)[source]
+apply_user_mods(user_mods_dirs=None)[source]User mods can be specified on the create_newcase command line (usually when called from create test) or they can be in the compset definition, or both.
If user_mods_dirs is specified, it should be a list of paths giving the user mods @@ -182,7 +183,7 @@
Submodules
- -archive_last_restarts(archive_restdir, rundir, last_date=None, link_to_restart_files=False)
+archive_last_restarts(archive_restdir, rundir, last_date=None, link_to_restart_files=False)Convenience function for archiving just the last set of restart files to a given directory. This also saves files attached to the restart set, such as rpointer files and necessary history @@ -196,43 +197,43 @@
Submodules
- -cancel_batch_jobs(jobids)[source]
+cancel_batch_jobs(jobids)[source]
- -case_cmpgen_namelists(compare=False, generate=False, compare_name=None, generate_name=None, baseline_root=None, logfile_name='TestStatus.log') +case_cmpgen_namelists(compare=False, generate=False, compare_name=None, generate_name=None, baseline_root=None, logfile_name='TestStatus.log')
- -case_run(skip_pnl=False, set_continue_run=False, submit_resubmits=False) +case_run(skip_pnl=False, set_continue_run=False, submit_resubmits=False)
- -case_setup(clean=False, test_mode=False, reset=False, keep=None) +case_setup(clean=False, test_mode=False, reset=False, keep=None)
- -case_st_archive(last_date_str=None, archive_incomplete_logs=True, copy_only=False, resubmit=True) +case_st_archive(last_date_str=None, archive_incomplete_logs=True, copy_only=False, resubmit=True)
Create archive object and perform short term archiving
- -case_test(testname=None, reset=False, skip_pnl=False) +case_test(testname=None, reset=False, skip_pnl=False)
- -check_all_input_data(protocol=None, address=None, input_data_root=None, data_list_dir='Buildconf', download=True, chksum=False) +check_all_input_data(protocol=None, address=None, input_data_root=None, data_list_dir='Buildconf', download=True, chksum=False)
Read through all files of the form *.input_data_list in the data_list_dir directory. These files contain a list of input and boundary files needed by each model component. For each file in the list confirm that it is available in input_data_root and if not (optionally download it from a @@ -241,17 +242,17 @@
Submodules
- -check_case(skip_pnl=False, chksum=False)
+check_case(skip_pnl=False, chksum=False)
- -check_input_data(protocol='svn', address=None, input_data_root=None, data_list_dir='Buildconf', download=False, user=None, passwd=None, chksum=False, ic_filepath=None) +check_input_data(protocol='svn', address=None, input_data_root=None, data_list_dir='Buildconf', download=False, user=None, passwd=None, chksum=False, ic_filepath=None)
For a given case check for the relevant input data as specified in data_list_dir/*.input_data_list in the directory input_data_root, if not found optionally download it using the servers specified in config_inputdata.xml. If a chksum file is available compute the chksum and compare it to that @@ -261,55 +262,55 @@
Submodules
- -check_lockedfile(filebase)
+check_lockedfile(filebase)
- -check_lockedfiles(skip=None) +check_lockedfiles(skip=None)
Check that all lockedfiles match what’s in case
If caseroot is not specified, it is set to the current working directory
- -check_pelayouts_require_rebuild(models) +check_pelayouts_require_rebuild(models)
Create if we require a rebuild, expects cwd is caseroot
- -configure(compset_name, grid_name, machine_name=None, project=None, pecount=None, compiler=None, mpilib=None, pesfile=None, gridfile=None, multi_driver=False, ninst=1, test=False, walltime=None, queue=None, output_root=None, run_unsupported=False, answer=None, input_dir=None, driver=None, workflowid='default', non_local=False, extra_machines_dir=None, case_group=None, ngpus_per_node=0, gpu_type=None, gpu_offload=None)[source] +configure(compset_name, grid_name, machine_name=None, project=None, pecount=None, compiler=None, mpilib=None, pesfile=None, gridfile=None, multi_driver=False, ninst=1, test=False, walltime=None, queue=None, output_root=None, run_unsupported=False, answer=None, input_dir=None, driver=None, workflowid='default', non_local=False, extra_machines_dir=None, case_group=None, ngpus_per_node=0, gpu_type=None, gpu_offload=None)[source]
- -copy(newcasename, newcaseroot, newcimeroot=None, newsrcroot=None)[source] +copy(newcasename, newcaseroot, newcimeroot=None, newsrcroot=None)[source]
- -create(casename, srcroot, compset_name, grid_name, user_mods_dirs=None, machine_name=None, project=None, pecount=None, compiler=None, mpilib=None, pesfile=None, gridfile=None, multi_driver=False, ninst=1, test=False, walltime=None, queue=None, output_root=None, run_unsupported=False, answer=None, input_dir=None, driver=None, workflowid='default', non_local=False, extra_machines_dir=None, case_group=None, ngpus_per_node=0, gpu_type=None, gpu_offload=None)[source] +create(casename, srcroot, compset_name, grid_name, user_mods_dirs=None, machine_name=None, project=None, pecount=None, compiler=None, mpilib=None, pesfile=None, gridfile=None, multi_driver=False, ninst=1, test=False, walltime=None, queue=None, output_root=None, run_unsupported=False, answer=None, input_dir=None, driver=None, workflowid='default', non_local=False, extra_machines_dir=None, case_group=None, ngpus_per_node=0, gpu_type=None, gpu_offload=None)[source]
- -create_clone(newcaseroot, keepexe=False, mach_dir=None, project=None, cime_output_root=None, exeroot=None, rundir=None, user_mods_dirs=None) +create_clone(newcaseroot, keepexe=False, mach_dir=None, project=None, cime_output_root=None, exeroot=None, rundir=None, user_mods_dirs=None)
Create a case clone
If exeroot or rundir are provided (not None), sets these directories to the given paths; if not provided, uses default values for these @@ -318,212 +319,217 @@
Submodules
- -create_dirs()
+create_dirs()Make necessary directories for case
- -fix_sys_argv_quotes(cmd)[source] +fix_sys_argv_quotes(cmd)[source]
Fixes removed quotes from argument list.
Restores quotes to –val and KEY=VALUE from sys.argv.
- -get_build_threaded()[source] +get_build_threaded()[source]
Returns True if current settings require a threaded build/run.
- -get_env(short_name, allow_missing=False)[source] +get_env(short_name, allow_missing=False)[source]
- -get_job_info()[source] +get_job_info()[source]
Get information on batch jobs associated with this case
- -get_latest_cpl_log(coupler_log_path=None, cplname='cpl')[source] +get_latest_cpl_log(coupler_log_path=None, cplname='cpl')[source]
find and return the latest cpl log file in the coupler_log_path directory
- -get_mpirun_cmd(job=None, allow_unresolved_envvars=True, overrides=None)[source] +get_mpirun_cmd(job=None, allow_unresolved_envvars=True, overrides=None)[source]
- -get_record_fields(variable, field)[source] +get_record_fields(variable, field)[source]
get_record_fields gets individual requested field from an entry_id file this routine is used only by xmlquery
- -get_resolved_value(item, recurse=0, allow_unresolved_envvars=False)[source] +get_resolved_value(item, recurse=0, allow_unresolved_envvars=False)[source]
- -get_value(item, attribute=None, resolved=True, subgroup=None)[source] +get_value(item, attribute=None, resolved=True, subgroup=None)[source]
- -get_values(item, attribute=None, resolved=True, subgroup=None)[source] +get_values(item, attribute=None, resolved=True, subgroup=None)[source]
- -initialize_derived_attributes()[source] +initialize_derived_attributes()[source]
These are derived variables which can be used in the config_* files for variable substitution using the {{ var }} syntax
- -is_save_timing_dir_project(project)[source] +is_save_timing_dir_project(project)[source]
Check whether the project is permitted to archive performance data in the location specified for the current machine
- -load_env(reset=False, job=None, verbose=False)[source] +load_env(reset=False, job=None, verbose=False)[source]
- -restore_from_archive(rest_dir=None, dout_s_root=None, rundir=None, test=False) +restore_from_archive(rest_dir=None, dout_s_root=None, rundir=None, test=False)
Take archived restart files and load them into current case. Use rest_dir if provided otherwise use most recent restore_from_archive is a member of Class Case
- -set_file(xmlfile)[source] +set_file(xmlfile)[source]
force the case object to consider only xmlfile
- -set_valid_values(item, valid_values)[source] +set_valid_values(item, valid_values)[source]
Update or create a valid_values entry for item and populate it
- -set_value(item, value, subgroup=None, ignore_type=False, allow_undefined=False, return_file=False)[source] +set_value(item, value, subgroup=None, ignore_type=False, allow_undefined=False, return_file=False)[source]
If a file has been defined, and the variable is in the file, then that value will be set in the file object and the resovled value is returned unless return_file is True, in which case (resolved_value, filename) @@ -532,7 +538,7 @@
Submodules
- -stage_refcase(input_data_root=None, data_list_dir=None)
+stage_refcase(input_data_root=None, data_list_dir=None)Get a REFCASE for a hybrid or branch run This is the only case in which we are downloading an entire directory instead of a single file at a time.
@@ -540,33 +546,33 @@Submodules
- -submit(job=None, no_batch=False, prereq=None, allow_fail=False, resubmit=False, resubmit_immediate=False, skip_pnl=False, mail_user=None, mail_type=None, batch_args=None, workflow=True, chksum=False)
+submit(job=None, no_batch=False, prereq=None, allow_fail=False, resubmit=False, resubmit_immediate=False, skip_pnl=False, mail_user=None, mail_type=None, batch_args=None, workflow=True, chksum=False)
- -submit_jobs(no_batch=False, job=None, skip_pnl=None, prereq=None, allow_fail=False, resubmit_immediate=False, mail_user=None, mail_type=None, batch_args=None, dry_run=False, workflow=True)[source] +submit_jobs(no_batch=False, job=None, skip_pnl=None, prereq=None, allow_fail=False, resubmit_immediate=False, mail_user=None, mail_type=None, batch_args=None, dry_run=False, workflow=True)[source]
- -update_env(new_object, env_file, blow_away=False)[source] +update_env(new_object, env_file, blow_away=False)[source]
Replace a case env object file
- -valid_compset(compset_name, compset_alias, files)[source] +valid_compset(compset_name, compset_alias, files)[source]
Add stub models missing in <compset_name>, return full compset name. <files> is used to collect set of all supported components.
Submodules -
CIME.case.case_clone module
+CIME.case.case_clone module
create_clone is a member of the Case class from file case.py
- -CIME.case.case_clone.create_clone(self, newcaseroot, keepexe=False, mach_dir=None, project=None, cime_output_root=None, exeroot=None, rundir=None, user_mods_dirs=None)[source] +CIME.case.case_clone.create_clone(self, newcaseroot, keepexe=False, mach_dir=None, project=None, cime_output_root=None, exeroot=None, rundir=None, user_mods_dirs=None)[source]
Create a case clone
If exeroot or rundir are provided (not None), sets these directories to the given paths; if not provided, uses default values for these @@ -588,43 +594,43 @@
Submodules -
CIME.case.case_cmpgen_namelists module
+CIME.case.case_cmpgen_namelists module
Library for case.cmpgen_namelists. case_cmpgen_namelists is a member of Class case from file case.py
- -CIME.case.case_cmpgen_namelists.case_cmpgen_namelists(self, compare=False, generate=False, compare_name=None, generate_name=None, baseline_root=None, logfile_name='TestStatus.log')[source] +CIME.case.case_cmpgen_namelists.case_cmpgen_namelists(self, compare=False, generate=False, compare_name=None, generate_name=None, baseline_root=None, logfile_name='TestStatus.log')[source]
- CIME.case.case_run module
+CIME.case.case_run module
case_run is a member of Class Case ‘
- CIME.case.case_setup module
+CIME.case.case_setup module
Library for case.setup. case_setup is a member of class Case from file case.py
- CIME.case.case_st_archive module
+CIME.case.case_st_archive module
short term archiving case_st_archive, restore_from_archive, archive_last_restarts are members of class Case from file case.py
- -CIME.case.case_st_archive.archive_last_restarts(self, archive_restdir, rundir, last_date=None, link_to_restart_files=False)[source] +CIME.case.case_st_archive.archive_last_restarts(self, archive_restdir, rundir, last_date=None, link_to_restart_files=False)[source]
Convenience function for archiving just the last set of restart files to a given directory. This also saves files attached to the restart set, such as rpointer files and necessary history @@ -638,73 +644,73 @@
Submodules
- -CIME.case.case_st_archive.case_st_archive(self, last_date_str=None, archive_incomplete_logs=True, copy_only=False, resubmit=True)[source]
+CIME.case.case_st_archive.case_st_archive(self, last_date_str=None, archive_incomplete_logs=True, copy_only=False, resubmit=True)[source]Create archive object and perform short term archiving
- -CIME.case.case_st_archive.get_histfiles_for_restarts(rundir, archive, archive_entry, restfile, testonly=False)[source] +CIME.case.case_st_archive.get_histfiles_for_restarts(rundir, archive, archive_entry, restfile, testonly=False)[source]
query restart files to determine history files that are needed for restarts
Not doc-testable due to filesystem dependence
- -CIME.case.case_st_archive.restore_from_archive(self, rest_dir=None, dout_s_root=None, rundir=None, test=False)[source] +CIME.case.case_st_archive.restore_from_archive(self, rest_dir=None, dout_s_root=None, rundir=None, test=False)[source]
Take archived restart files and load them into current case. Use rest_dir if provided otherwise use most recent restore_from_archive is a member of Class Case
- CIME.case.case_submit module
+CIME.case.case_submit module
case.submit - Submit a cesm workflow to the queueing system or run it if there is no queueing system. A cesm workflow may include multiple jobs. submit, check_case and check_da_settings are members of class Case in file case.py
- -CIME.case.case_submit.check_DA_settings(self)[source] +CIME.case.case_submit.check_DA_settings(self)[source]
- -CIME.case.case_submit.check_case(self, skip_pnl=False, chksum=False)[source] +CIME.case.case_submit.check_case(self, skip_pnl=False, chksum=False)[source]
- -CIME.case.case_submit.submit(self, job=None, no_batch=False, prereq=None, allow_fail=False, resubmit=False, resubmit_immediate=False, skip_pnl=False, mail_user=None, mail_type=None, batch_args=None, workflow=True, chksum=False)[source] +CIME.case.case_submit.submit(self, job=None, no_batch=False, prereq=None, allow_fail=False, resubmit=False, resubmit_immediate=False, skip_pnl=False, mail_user=None, mail_type=None, batch_args=None, workflow=True, chksum=False)[source]
- CIME.case.case_test module
+CIME.case.case_test module
Run a testcase. case_test is a member of class Case from case.py
- CIME.case.check_input_data module
+CIME.case.check_input_data module
API for checking input for testcase
- -CIME.case.check_input_data.check_all_input_data(self, protocol=None, address=None, input_data_root=None, data_list_dir='Buildconf', download=True, chksum=False)[source] +CIME.case.check_input_data.check_all_input_data(self, protocol=None, address=None, input_data_root=None, data_list_dir='Buildconf', download=True, chksum=False)[source]
Read through all files of the form *.input_data_list in the data_list_dir directory. These files contain a list of input and boundary files needed by each model component. For each file in the list confirm that it is available in input_data_root and if not (optionally download it from a @@ -713,7 +719,7 @@
Submodules
- -CIME.case.check_input_data.check_input_data(case, protocol='svn', address=None, input_data_root=None, data_list_dir='Buildconf', download=False, user=None, passwd=None, chksum=False, ic_filepath=None)[source]
+CIME.case.check_input_data.check_input_data(case, protocol='svn', address=None, input_data_root=None, data_list_dir='Buildconf', download=False, user=None, passwd=None, chksum=False, ic_filepath=None)[source]For a given case check for the relevant input data as specified in data_list_dir/*.input_data_list in the directory input_data_root, if not found optionally download it using the servers specified in config_inputdata.xml. If a chksum file is available compute the chksum and compare it to that @@ -723,13 +729,13 @@
Submodules
- -CIME.case.check_input_data.md5(fname)[source]
+CIME.case.check_input_data.md5(fname)[source]performs an md5 sum one chunk at a time to avoid memory issues with large files.
- -CIME.case.check_input_data.stage_refcase(self, input_data_root=None, data_list_dir=None)[source] +CIME.case.check_input_data.stage_refcase(self, input_data_root=None, data_list_dir=None)[source]
Get a REFCASE for a hybrid or branch run This is the only case in which we are downloading an entire directory instead of a single file at a time.
@@ -737,55 +743,55 @@Submodules
- -CIME.case.check_input_data.verify_chksum(input_data_root, rundir, filename, isdirectory)[source]
+CIME.case.check_input_data.verify_chksum(input_data_root, rundir, filename, isdirectory)[source]For file in filename perform a chksum and compare the result to that stored in the local checksumfile, if isdirectory chksum all files in the directory of form .
- CIME.case.check_lockedfiles module
+CIME.case.check_lockedfiles module
API for checking locked files check_lockedfile, check_lockedfiles, check_pelayouts_require_rebuild are members of Class case.py from file case.py
- -CIME.case.check_lockedfiles.check_lockedfile(self, filebase)[source] +CIME.case.check_lockedfiles.check_lockedfile(self, filebase)[source]
- CIME.case.preview_namelists module
+CIME.case.preview_namelists module
API for preview namelist create_dirs and create_namelists are members of Class case from file case.py
- Module contents
+Module contents
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package
+- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package
@@ -138,9 +139,9 @@- diff --git a/versions/master/html/CIME_api/CIME.data.html b/versions/master/html/CIME_api/CIME.data.html index 4dd090ce4f9..d039358f46b 100644 --- a/versions/master/html/CIME_api/CIME.data.html +++ b/versions/master/html/CIME_api/CIME.data.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@CIME.data.config package
+CIME.data.config package
- Module contents
+Module contents
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package
+- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package
@@ -137,9 +138,9 @@- CIME.data package
+CIME.data package
- Subpackages
+Subpackages
- CIME.data.config package
-
@@ -154,7 +155,7 @@
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package +
- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package @@ -138,9 +139,9 @@
- CIME.SystemTests package
- CIME.Tools package
- CIME.XML package +
- CIME.baselines package
- CIME.build_scripts package
- CIME.case package
- CIME.data package @@ -80,8 +81,10 @@
- CIME.bless_test_results module
- CIME.build module
-
@@ -128,6 +131,7 @@
- CIME.config module
- CIME.cs_status module
-
@@ -155,6 +159,7 @@
get_test_suite()get_test_suites()infer_arch_from_tests()
+is_perf_test()key_test_time()suite_has_test()
IndentFormatterSharedAreaTimeout
+add_flag_to_cmd()add_mail_type_args()analyze_build_log()append_case_status()
@@ -399,9 +405,9 @@
- CIME.BuildTools package
-
@@ -731,6 +737,7 @@
Subpackages
fix_single_exe_case() is_single_exe_case()
+perf_check_for_memory_leak()- CIME.SystemTests.system_tests_compare_n module
-
@@ -925,6 +932,7 @@
Subpackages
EnvBatch.submit_jobs()
+ get_job_deps()- CIME.XML.env_build module
-
@@ -1217,6 +1225,25 @@
SubpackagesModule contents
+ - CIME.baselines package +
- CIME.build_scripts package
@@ -1252,6 +1279,7 @@
Subpackages
Case.create_namelists() Case.fix_sys_argv_quotes()Case.flush()
+Case.get_baseline_dir()Case.get_batch_jobs()Case.get_build_threaded()Case.get_case_root()
@@ -1698,6 +1726,47 @@ TestUnitBaselinesPerformance-
+
TestUnitBaselinesPerformance.test__perf_get_memory()
+TestUnitBaselinesPerformance.test__perf_get_memory_override()
+TestUnitBaselinesPerformance.test__perf_get_throughput()
+TestUnitBaselinesPerformance.test_get_cpl_mem_usage()
+TestUnitBaselinesPerformance.test_get_cpl_mem_usage_gz()
+TestUnitBaselinesPerformance.test_get_cpl_throughput()
+TestUnitBaselinesPerformance.test_get_cpl_throughput_no_file()
+TestUnitBaselinesPerformance.test_get_latest_cpl_logs()
+TestUnitBaselinesPerformance.test_get_latest_cpl_logs_found_multiple()
+TestUnitBaselinesPerformance.test_get_latest_cpl_logs_found_single()
+TestUnitBaselinesPerformance.test_perf_compare_memory_baseline()
+TestUnitBaselinesPerformance.test_perf_compare_memory_baseline_above_threshold()
+TestUnitBaselinesPerformance.test_perf_compare_memory_baseline_no_baseline()
+TestUnitBaselinesPerformance.test_perf_compare_memory_baseline_no_baseline_file()
+TestUnitBaselinesPerformance.test_perf_compare_memory_baseline_no_tolerance()
+TestUnitBaselinesPerformance.test_perf_compare_memory_baseline_not_enough_samples()
+TestUnitBaselinesPerformance.test_perf_compare_throughput_baseline()
+TestUnitBaselinesPerformance.test_perf_compare_throughput_baseline_above_threshold()
+TestUnitBaselinesPerformance.test_perf_compare_throughput_baseline_no_baseline()
+TestUnitBaselinesPerformance.test_perf_compare_throughput_baseline_no_baseline_file()
+TestUnitBaselinesPerformance.test_perf_compare_throughput_baseline_no_tolerance()
+TestUnitBaselinesPerformance.test_perf_get_memory()
+TestUnitBaselinesPerformance.test_perf_get_memory_default()
+TestUnitBaselinesPerformance.test_perf_get_memory_default_no_value()
+TestUnitBaselinesPerformance.test_perf_get_throughput()
+TestUnitBaselinesPerformance.test_perf_get_throughput_default()
+TestUnitBaselinesPerformance.test_perf_get_throughput_default_no_value()
+TestUnitBaselinesPerformance.test_perf_write_baseline()
+TestUnitBaselinesPerformance.test_read_baseline_file()
+TestUnitBaselinesPerformance.test_read_baseline_file_content()
+TestUnitBaselinesPerformance.test_read_baseline_file_multi_line()
+TestUnitBaselinesPerformance.test_write_baseline_file()
+TestUnitBaselinesPerformance.test_write_baseline_runtimeerror()
+TestUnitBaselinesPerformance.test_write_baseline_skip()
+
+create_mock_case()
+- CIME.tests.test_unit_case module
TestCaseTestCase.setUp()
@@ -1714,6 +1783,7 @@
Subpackages
TestCaseSubmit
@@ -1938,11 +2008,23 @@ TestCaseSubmit-
-
TestCaseSubmit.test_dry_run()
-TestCaseSubmit.test_kwargs()
+TestUnitSystemTests-
+
TestUnitSystemTests.test_check_for_memleak()
+TestUnitSystemTests.test_check_for_memleak_found()
+TestUnitSystemTests.test_check_for_memleak_not_enough_samples()
+TestUnitSystemTests.test_check_for_memleak_runtime_error()
+TestUnitSystemTests.test_compare_memory()
+TestUnitSystemTests.test_compare_memory_erorr_diff()
+TestUnitSystemTests.test_compare_memory_erorr_fail()
+TestUnitSystemTests.test_compare_throughput()
+TestUnitSystemTests.test_compare_throughput_error_diff()
+TestUnitSystemTests.test_compare_throughput_fail()
+TestUnitSystemTests.test_dry_run()
+TestUnitSystemTests.test_generate_baseline()
+TestUnitSystemTests.test_kwargs()
+create_mock_case()
- CIME.tests.test_unit_test_status module
-
@@ -2067,6 +2149,7 @@
SubpackagesCIME.tests.test_unit_xml_env_batch module
- -CIME.bless_test_results.bless_history(test_name, case, baseline_name, baseline_root, report_only, force)[source] +CIME.bless_test_results.bless_history(test_name, case, baseline_name, baseline_root, report_only, force)[source] +
- +CIME.bless_test_results.bless_memory(case, test_name, baseline_root, baseline_name, report_only, force)[source]
- -CIME.bless_test_results.bless_namelists(test_name, report_only, force, pesfile, baseline_name, baseline_root, new_test_root=None, new_test_id=None)[source] +CIME.bless_test_results.bless_namelists(test_name, report_only, force, pesfile, baseline_name, baseline_root, new_test_root=None, new_test_id=None)[source]
- -CIME.bless_test_results.bless_test_results(baseline_name, baseline_root, test_root, compiler, test_id=None, namelists_only=False, hist_only=False, report_only=False, force=False, pesfile=None, bless_tests=None, no_skip_pass=False, new_test_root=None, new_test_id=None)[source] +CIME.bless_test_results.bless_test_results(baseline_name, baseline_root, test_root, compiler, test_id=None, namelists_only=False, hist_only=False, tput_only=False, mem_only=False, report_only=False, force=False, pesfile=None, bless_tests=None, no_skip_pass=False, new_test_root=None, new_test_id=None, **_)[source] +
- -class CIME.build.CmakeTmpBuildDir(macroloc=None, rootdir=None, tmpdir=None)[source] +class CIME.build.CmakeTmpBuildDir(macroloc=None, rootdir=None, tmpdir=None)[source]
Bases:
objectUse to create a temporary cmake build dir for the purposes of querying Macros.
- -get_makefile_vars(case=None, comp=None, cmake_args=None)[source] +get_makefile_vars(case=None, comp=None, cmake_args=None)[source]
Run cmake and process output to a list of variable settings
case can be None if caller is providing their own cmake args
Submodules
- -CIME.build.case_build(caseroot, case, sharedlib_only=False, model_only=False, buildlist=None, save_build_provenance=True, separate_builds=False, ninja=False, dry_run=False)[source]
+CIME.build.case_build(caseroot, case, sharedlib_only=False, model_only=False, buildlist=None, save_build_provenance=True, separate_builds=False, ninja=False, dry_run=False)[source]- -CIME.build.clean(case, cleanlist=None, clean_all=False, clean_depends=None)[source] +CIME.build.clean(case, cleanlist=None, clean_all=False, clean_depends=None)[source]
- -CIME.build.generate_makefile_macro(case, caseroot)[source] +CIME.build.generate_makefile_macro(case, caseroot)[source]
Generates a flat Makefile macro file based on the CMake cache system. This macro is only used by certain sharedlibs since components use CMake. Since indirection based on comp_name is allowed for sharedlibs, each sharedlib must generate @@ -2240,124 +2336,124 @@
Submodules
- -CIME.build.get_standard_cmake_args(case, sharedpath)[source]
+CIME.build.get_standard_cmake_args(case, sharedpath)[source]- -CIME.build.get_standard_makefile_args(case, shared_lib=False)[source] +CIME.build.get_standard_makefile_args(case, shared_lib=False)[source]
- -CIME.buildnml.build_xcpl_nml(case, caseroot, compname)[source] +CIME.buildnml.build_xcpl_nml(case, caseroot, compname)[source]
- -CIME.buildnml.copy_inputs_to_rundir(caseroot, compname, confdir, rundir, inst_string)[source] +CIME.buildnml.copy_inputs_to_rundir(caseroot, compname, confdir, rundir, inst_string)[source]
- -CIME.compare_test_results.append_status_cprnc_log(msg, logfile_name, test_dir)[source] +CIME.compare_test_results.append_status_cprnc_log(msg, logfile_name, test_dir)[source]
- -CIME.compare_test_results.compare_history(case, baseline_name, baseline_root, log_id)[source] +CIME.compare_test_results.compare_history(case, baseline_name, baseline_root, log_id)[source]
- -CIME.compare_test_results.compare_namelists(case, baseline_name, baseline_root, logfile_name)[source] +CIME.compare_test_results.compare_namelists(case, baseline_name, baseline_root, logfile_name)[source]
- -CIME.compare_test_results.compare_test_results(baseline_name, baseline_root, test_root, compiler, test_id=None, compare_tests=None, namelists_only=False, hist_only=False)[source] +CIME.compare_test_results.compare_test_results(baseline_name, baseline_root, test_root, compiler, test_id=None, compare_tests=None, namelists_only=False, hist_only=False)[source]
Compares with baselines for all matching tests
Outputs results for each test to stdout (one line per test); possible status codes are: PASS, FAIL, SKIP. (A SKIP denotes a test that did not make it to @@ -2372,38 +2468,49 @@
Submodules -
CIME.config module
+CIME.config module
- -class CIME.config.Config[source] +class CIME.config.Config[source] +
Bases:
+ConfigBase
- -CIME.cs_status.cs_status(test_paths, summary=False, fails_only=False, count_fails_phase_list=None, check_throughput=False, check_memory=False, expected_fails_filepath=None, force_rebuild=False, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)[source] +CIME.cs_status.cs_status(test_paths, summary=False, fails_only=False, count_fails_phase_list=None, check_throughput=False, check_memory=False, expected_fails_filepath=None, force_rebuild=False, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)[source]
Print the test statuses of all tests in test_paths. The default is to print to stdout, but this can be overridden with the ‘out’ argument.
@@ -2423,11 +2530,11 @@Submodules -
CIME.cs_status_creator module
+CIME.cs_status_creator module
Creates a test suite-specific cs.status file from a template
- -CIME.cs_status_creator.create_cs_status(test_root, test_id, extra_args='', filename=None)[source] +CIME.cs_status_creator.create_cs_status(test_root, test_id, extra_args='', filename=None)[source]
Create a test suite-specific cs.status file from the template
Arguments: test_root (string): path to test root; the file will be put here. If
@@ -2450,10 +2557,10 @@Submodules -
CIME.date module
+CIME.date module
- -class CIME.date.date(year=1, month=1, day=1, hour=0, minute=0, second=0)[source] +class CIME.date.date(year=1, month=1, day=1, hour=0, minute=0, second=0)[source]
Bases:
objectSimple struct for holding dates and the time of day and performing comparisons
Difference in Hour, Minute, or Second @@ -2566,54 +2673,54 @@
Submodules
- -day()[source]
+day()[source]
- -CIME.date.get_file_date(filename)[source] +CIME.date.get_file_date(filename)[source]
Returns the date associated with the filename as a date object representing the correct date Formats supported: “%Y-%m-%d_%h.%M.%s @@ -2642,21 +2749,21 @@
Submodules -
CIME.expected_fails module
+CIME.expected_fails module
Contains the definition of a class to hold information on expected failures for a single test
- -class CIME.expected_fails.ExpectedFails[source] +class CIME.expected_fails.ExpectedFails[source]
Bases:
object- -add_failure(phase, expected_status)[source] +add_failure(phase, expected_status)[source]
Add an expected failure to the list
- -expected_fails_comment(phase, status)[source] +expected_fails_comment(phase, status)[source]
Returns a string giving the expected fails comment for this phase and status
Submodules -
CIME.get_tests module
+CIME.get_tests module
- -CIME.get_tests.get_build_groups(tests)[source] +CIME.get_tests.get_build_groups(tests)[source]
Given a list of tests, return a list of lists, with each list representing a group of tests that can share executables.
>>> tests = ["SMS_P2.f19_g16_rx1.A.melvin_gnu", "SMS_P4.f19_g16_rx1.A.melvin_gnu", "SMS_P2.f19_g16_rx1.X.melvin_gnu", "SMS_P4.f19_g16_rx1.X.melvin_gnu", "TESTRUNSLOWPASS_P1.f19_g16_rx1.A.melvin_gnu", "TESTRUNSLOWPASS_P1.ne30_g16_rx1.A.melvin_gnu"] @@ -2679,7 +2786,7 @@
Submodules
- -CIME.get_tests.get_full_test_names(testargs, machine, compiler)[source]
+CIME.get_tests.get_full_test_names(testargs, machine, compiler)[source]Return full test names in the form: TESTCASE.GRID.COMPSET.MACHINE_COMPILER.TESTMODS Testmods are optional
@@ -2708,7 +2815,7 @@Submodules
- -CIME.get_tests.get_recommended_test_time(test_full_name)[source]
+CIME.get_tests.get_recommended_test_time(test_full_name)[source]@@ -2725,24 +2832,24 @@>>> get_recommended_test_time("ERS.f19_g16_rx1.A.melvin_gnu") '0:10:00'
Submodules
- -CIME.get_tests.get_test_data(suite)[source]
-For a given suite, returns (inherit, time, share, tests)
+CIME.get_tests.get_test_data(suite)[source] +For a given suite, returns (inherit, time, share, perf, tests)
- -CIME.get_tests.get_test_suite(suite, machine=None, compiler=None, skip_inherit=False, skip_tests=None)[source] +CIME.get_tests.get_test_suite(suite, machine=None, compiler=None, skip_inherit=False, skip_tests=None)[source]
Return a list of FULL test names for a suite.
- -CIME.get_tests.infer_arch_from_tests(testargs)[source] +CIME.get_tests.infer_arch_from_tests(testargs)[source]
Return a tuple (machine, [compilers]) that can be inferred from the test args
>>> infer_arch_from_tests(["NCK.f19_g16_rx1.A.melvin_gnu"]) ('melvin', ['gnu']) @@ -2762,33 +2869,47 @@
Submodules +
- +CIME.get_tests.is_perf_test(test)[source]
+Is the provided test in a suite with perf=True?
+++>>> is_perf_test("SMS_P2.T42_T42.S.melvin_gnu") +True +>>> is_perf_test("SMS_P2.f19_g16_rx1.X.melvin_gnu") +False +>>> is_perf_test("PFS_P2.f19_g16_rx1.X.melvin_gnu") +True +
- -CIME.get_tests.key_test_time(test_full_name)[source] +CIME.get_tests.key_test_time(test_full_name)[source]
- -CIME.get_tests.suite_has_test(suite, test_full_name, skip_inherit=False)[source] +CIME.get_tests.suite_has_test(suite, test_full_name, skip_inherit=False)[source]
- CIME.get_timing module
+CIME.get_timing module
Library for implementing getTiming tool which gets timing information from a run.
- CIME.hist_utils module
+CIME.hist_utils module
Functions for actions pertaining to history files.
- -CIME.hist_utils.compare_baseline(case, baseline_dir=None, outfile_suffix='')[source] +CIME.hist_utils.compare_baseline(case, baseline_dir=None, outfile_suffix='')[source]
compare the current test output to a baseline result
case - The case containing the hist files to be compared against baselines baseline_dir - Optionally, specify a specific baseline dir, otherwise it will be computed from case config @@ -2802,7 +2923,7 @@
Submodules
- -CIME.hist_utils.compare_test(case, suffix1, suffix2, ignore_fieldlist_diffs=False)[source]
+CIME.hist_utils.compare_test(case, suffix1, suffix2, ignore_fieldlist_diffs=False)[source]Compares two sets of component history files in the testcase directory
case - The case containing the hist files to compare suffix1 - The suffix that identifies the first batch of hist files @@ -2818,7 +2939,7 @@
Submodules
- -CIME.hist_utils.copy_histfiles(case, suffix, match_suffix=None)[source]
+CIME.hist_utils.copy_histfiles(case, suffix, match_suffix=None)[source]Copy the most recent batch of hist files in a case, adding the given suffix.
This can allow you to temporarily “save” these files so they won’t be blown away if you re-run the case.
@@ -2829,7 +2950,7 @@Submodules
- -CIME.hist_utils.cprnc(model, file1, file2, case, rundir, multiinst_driver_compare=False, outfile_suffix='', ignore_fieldlist_diffs=False, cprnc_exe=None)[source]
+CIME.hist_utils.cprnc(model, file1, file2, case, rundir, multiinst_driver_compare=False, outfile_suffix='', ignore_fieldlist_diffs=False, cprnc_exe=None)[source]Run cprnc to compare two individual nc files
file1 - the full or relative path of the first file file2 - the full or relative path of the second file @@ -2853,19 +2974,19 @@
Submodules
- -CIME.hist_utils.generate_baseline(case, baseline_dir=None, allow_baseline_overwrite=False)[source]
+CIME.hist_utils.generate_baseline(case, baseline_dir=None, allow_baseline_overwrite=False)[source]
- -CIME.hist_utils.generate_teststatus(testdir, baseline_dir)[source] +CIME.hist_utils.generate_teststatus(testdir, baseline_dir)[source]
CESM stores it’s TestStatus file in baselines. Do not let exceptions escape from this function.
- -CIME.hist_utils.get_ts_synopsis(comments)[source] +CIME.hist_utils.get_ts_synopsis(comments)[source]
Reduce case diff comments down to a single line synopsis so that we can put something in the TestStatus file. It’s expected that the comments provided to this function came from compare_baseline, not compare_tests.
@@ -2895,7 +3016,7 @@Submodules
- -CIME.hist_utils.rename_all_hist_files(case, suffix)[source]
+CIME.hist_utils.rename_all_hist_files(case, suffix)[source]Renaming all hist files in a case, adding the given suffix.
case - The case containing the files you want to save suffix - The string suffix you want to add to saved files, this can be used to find them later.
@@ -2903,60 +3024,60 @@Submodules -
CIME.jenkins_generic_job module
+CIME.jenkins_generic_job module
- -CIME.jenkins_generic_job.archive_old_test_data(machine, mach_comp, test_id_root, test_root, old_test_archive, avoid_test_id)[source] +CIME.jenkins_generic_job.archive_old_test_data(machine, mach_comp, test_id_root, test_root, old_test_archive, avoid_test_id)[source]
- -CIME.jenkins_generic_job.cleanup_queue(test_root, test_id)[source] +CIME.jenkins_generic_job.cleanup_queue(test_root, test_id)[source]
Delete all jobs left in the queue
- -CIME.jenkins_generic_job.delete_old_test_data(mach_comp, test_id_root, scratch_root, test_root, run_area, build_area, archive_area, avoid_test_id)[source] +CIME.jenkins_generic_job.delete_old_test_data(mach_comp, test_id_root, scratch_root, test_root, run_area, build_area, archive_area, avoid_test_id)[source]
- -CIME.jenkins_generic_job.handle_old_test_data(machine, compiler, test_id_root, scratch_root, test_root, avoid_test_id)[source] +CIME.jenkins_generic_job.handle_old_test_data(machine, compiler, test_id_root, scratch_root, test_root, avoid_test_id)[source]
- -CIME.jenkins_generic_job.jenkins_generic_job(generate_baselines, submit_to_cdash, no_batch, baseline_name, arg_cdash_build_name, cdash_project, arg_test_suite, cdash_build_group, baseline_compare, scratch_root, parallel_jobs, walltime, machine, compiler, real_baseline_name, baseline_root, update_success, check_throughput, check_memory, ignore_memleak, pes_file, jenkins_id, queue)[source] +CIME.jenkins_generic_job.jenkins_generic_job(generate_baselines, submit_to_cdash, no_batch, baseline_name, arg_cdash_build_name, cdash_project, arg_test_suite, cdash_build_group, baseline_compare, scratch_root, parallel_jobs, walltime, machine, compiler, real_baseline_name, baseline_root, update_success, check_throughput, check_memory, ignore_memleak, pes_file, jenkins_id, queue)[source]
Return True if all tests passed
- CIME.locked_files module
+CIME.locked_files module
- -CIME.locked_files.is_locked(filename, caseroot=None)[source] +CIME.locked_files.is_locked(filename, caseroot=None)[source]
- CIME.namelist module
+CIME.namelist module
Module containing tools for dealing with Fortran namelists.
The public interface consists of the following functions: - character_literal_to_string @@ -3013,7 +3134,7 @@
Submodules
- -class CIME.namelist.Namelist(groups=None)[source]
+class CIME.namelist.Namelist(groups=None)[source]Bases:
objectClass representing a Fortran namelist.
Public methods: @@ -3028,12 +3149,12 @@
Submodules
- -clean_groups()[source]
+clean_groups()[source]- -delete_variable(group_name, variable_name)[source] +delete_variable(group_name, variable_name)[source]
Delete a variable from a specified group.
If the specified group or variable does not exist, this is a no-op.
>>> x = parse(text='&foo bar=1 /') @@ -3050,7 +3171,7 @@
Submodules
- -get_group_names()[source]
+get_group_names()[source]Return a list of all groups in the namelist.
>>> Namelist().get_group_names() [] @@ -3062,12 +3183,12 @@
Submodules
- -get_group_variables(group_name)[source]
+get_group_variables(group_name)[source]- -get_value(variable_name)[source] +get_value(variable_name)[source]
Return the value of a uniquely-named variable.
This function is similar to get_variable_value, except that it does not require a group_name, and it requires that the variable_name be @@ -3088,7 +3209,7 @@
Submodules
- -get_variable_names(group_name)[source]
+get_variable_names(group_name)[source]Return a list of all variables in the given namelist group.
If the specified group is not in the namelist, returns an empty list.
>>> Namelist().get_variable_names('foo') @@ -3108,7 +3229,7 @@
Submodules
- -get_variable_value(group_name, variable_name)[source]
+get_variable_value(group_name, variable_name)[source]Return the value of the specified variable.
This function always returns a non-empty list containing strings. If the specified group_name or variable_name is not present, [‘’] is @@ -3125,7 +3246,7 @@
Submodules
- -merge_nl(other, overwrite=False)[source]
+merge_nl(other, overwrite=False)[source]Merge this namelist object with another.
Values in the invoking (self) Namelist will take precedence over values in the other Namelist, unless overwrite=True is passed in, @@ -3176,7 +3297,7 @@
Submodules
- -set_variable_value(group_name, variable_name, value, var_size=1)[source]
+set_variable_value(group_name, variable_name, value, var_size=1)[source]Set the value of the specified variable.
>>> x = parse(text='&foo bar=1 /') >>> x.get_variable_value('foo', 'bar') @@ -3205,7 +3326,7 @@
Submodules
- -write(out_file, groups=None, append=False, format_='nml', sorted_groups=True)[source]
+write(out_file, groups=None, append=False, format_='nml', sorted_groups=True)[source]Write a the output data (normally fortran namelist) to the out_file
As with parse, the out_file argument can be either a file name, or a file object with a write method that accepts unicode. If specified, @@ -3220,7 +3341,7 @@
Submodules
- -write_nuopc(out_file, groups=None, sorted_groups=True)[source]
+write_nuopc(out_file, groups=None, sorted_groups=True)[source]Write a nuopc config file out_file
As with parse, the out_file argument can be either a file name, or a file object with a write method that accepts unicode. If specified, @@ -3231,7 +3352,7 @@
Submodules
- -CIME.namelist.character_literal_to_string(literal)[source]
+CIME.namelist.character_literal_to_string(literal)[source]Convert a Fortran character literal to a Python string.
This function assumes (without checking) that literal is a valid literal.
>>> character_literal_to_string("'blah'") @@ -3248,7 +3369,7 @@
Submodules
- -CIME.namelist.compress_literal_list(literals)[source]
+CIME.namelist.compress_literal_list(literals)[source]Uses repetition syntax to shorten a literal list.
>>> compress_literal_list([]) [] @@ -3264,7 +3385,7 @@
Submodules
- -CIME.namelist.expand_literal_list(literals)[source]
+CIME.namelist.expand_literal_list(literals)[source]Expands a list of literal values to get rid of repetition syntax.
>>> expand_literal_list([]) [] @@ -3280,7 +3401,7 @@
Submodules
- -CIME.namelist.fortran_namelist_base_value(string)[source]
+CIME.namelist.fortran_namelist_base_value(string)[source]Strip off whitespace and repetition syntax from a namelist value.
>>> fortran_namelist_base_value("") '' @@ -3300,7 +3421,7 @@
Submodules
- -CIME.namelist.get_fortran_name_only(full_var)[source]
+CIME.namelist.get_fortran_name_only(full_var)[source]remove array section if any and return only the variable name >>> get_fortran_name_only(‘foo’) ‘foo’ @@ -3320,7 +3441,7 @@
Submodules
- -CIME.namelist.get_fortran_variable_indices(varname, varlen=1, allow_any_len=False)[source]
+CIME.namelist.get_fortran_variable_indices(varname, varlen=1, allow_any_len=False)[source]get indices from a fortran namelist variable as a triplet of minindex, maxindex and step
>>> get_fortran_variable_indices('foo(3)') (3, 3, 1) @@ -3338,7 +3459,7 @@
Submodules
- -CIME.namelist.is_valid_fortran_name(string)[source]
+CIME.namelist.is_valid_fortran_name(string)[source]Check that a variable name is allowed in Fortran.
The rules are: 1. The name must start with a letter. @@ -3383,7 +3504,7 @@
Submodules
- -CIME.namelist.is_valid_fortran_namelist_literal(type_, string)[source]
+CIME.namelist.is_valid_fortran_namelist_literal(type_, string)[source]Determine whether a literal is valid in a Fortran namelist.
Note that kind parameters are not allowed in namelists, which simplifies this check a bit. Internal whitespace is allowed for complex and character @@ -3638,7 +3759,7 @@
Submodules
- -CIME.namelist.literal_to_python_value(literal, type_=None)[source]
+CIME.namelist.literal_to_python_value(literal, type_=None)[source]Convert a Fortran literal string to a Python value.
This function assumes that the input contains a single value, i.e. repetition syntax is not used. The type can be specified by passing a string @@ -3698,7 +3819,7 @@
Submodules
- -CIME.namelist.merge_literal_lists(default, overwrite)[source]
+CIME.namelist.merge_literal_lists(default, overwrite)[source]Merge two lists of literal value strings.
The overwrite values have higher precedence, so will overwrite the default values. However, if overwrite contains null values, or is @@ -3726,7 +3847,7 @@
Submodules
- -CIME.namelist.parse(in_file=None, text=None, groupless=False, convert_tab_to_space=True)[source]
+CIME.namelist.parse(in_file=None, text=None, groupless=False, convert_tab_to_space=True)[source]Parse a Fortran namelist.
The in_file argument must be either a str or unicode object containing @@ -3763,14 +3884,14 @@
Submodules
- -CIME.namelist.shouldRaise(eclass, method, *args, **kw)[source]
+CIME.namelist.shouldRaise(eclass, method, *args, **kw)[source]A helper function to make doctests py3 compatible http://python3porting.com/problems.html#running-doctests
- -CIME.namelist.string_to_character_literal(string)[source] +CIME.namelist.string_to_character_literal(string)[source]
Convert a Python string to a Fortran character literal.
This function always uses double quotes (”) as the delimiter.
>>> string_to_character_literal('blah') @@ -3785,16 +3906,16 @@
Submodules -
CIME.nmlgen module
+CIME.nmlgen module
Class for generating component namelists.
- -class CIME.nmlgen.NamelistGenerator(case, definition_files, files=None)[source] +class CIME.nmlgen.NamelistGenerator(case, definition_files, files=None)[source]
Bases:
objectUtility class for generating namelists for a given component.
- -add_default(name, value=None, ignore_abs_path=None)[source] +add_default(name, value=None, ignore_abs_path=None)[source]
Add a value for the specified variable to the namelist.
If the specified variable is already defined in the object, the existing value is preserved. Otherwise, the value argument, if provided, will @@ -3807,7 +3928,7 @@
Submodules
- -add_defaults_for_group(group)[source]
+add_defaults_for_group(group)[source]Call add_default for namelist variables in the given group
This still skips variables that have attributes of skip_default_entry or per_stream_entry.
@@ -3817,18 +3938,18 @@Submodules
- -add_nmlcontents(filename, group, append=True, format_='nmlcontents', sorted_groups=True)[source]
+add_nmlcontents(filename, group, append=True, format_='nmlcontents', sorted_groups=True)[source]Write only contents of nml group
- -confirm_group_is_empty(group_name, errmsg)[source] +confirm_group_is_empty(group_name, errmsg)[source]
Confirms that no values have been added to the given group
If any values HAVE been added to this group, aborts with the given error message.
This is often paired with use of skip_default_for_groups in the init_defaults call @@ -3848,13 +3969,13 @@
Submodules
- -create_shr_strdata_nml()[source]
+create_shr_strdata_nml()[source]Set defaults for shr_strdata_nml variables other than the variable domainfile
- -create_stream_file_and_update_shr_strdata_nml(config, caseroot, stream, stream_path, data_list_path)[source] +create_stream_file_and_update_shr_strdata_nml(config, caseroot, stream, stream_path, data_list_path)[source]
Write the pseudo-XML file corresponding to a given stream.
Arguments: config - Used to look up namelist defaults. This is used in addition
@@ -3870,7 +3991,7 @@Submodules
- -get_default(name, config=None, allow_none=False)[source]
+get_default(name, config=None, allow_none=False)[source]Get the value of a variable from the namelist definition file.
The config argument is passed through to the underlying NamelistDefaults.get_value call as the attribute argument.
@@ -3903,18 +4024,18 @@Submodules
- -get_group_variables(group_name)[source]
+get_group_variables(group_name)[source]
- -get_streams()[source] +get_streams()[source]
Get a list of all streams used for the current data model mode.
- -get_value(name)[source] +get_value(name)[source]
Get the current value of a given namelist variable.
Note that the return value of this function is always a string or a list of strings. E.g. the scalar logical value .false. will be returned as @@ -3931,7 +4052,7 @@
Submodules
- -init_defaults(infiles, config, skip_groups=None, skip_entry_loop=False, skip_default_for_groups=None, set_group_name=None)[source]
+init_defaults(infiles, config, skip_groups=None, skip_entry_loop=False, skip_default_for_groups=None, set_group_name=None)[source]Return array of names of all definition nodes
infiles should be a list of file paths, each one giving namelist settings that take precedence over the default values. Often there will be only one file in this @@ -3944,33 +4065,33 @@
Submodules
- -new_instance()[source]
+new_instance()[source]Clean the object just enough to introduce a new instance
- -static quote_string(string)[source] +static quote_string(string)[source]
Convert a string to a quoted Fortran literal.
Does nothing if the string appears to be quoted already.
- -rename_group(group, newgroup)[source] +rename_group(group, newgroup)[source]
Pass through to namelist definition
- -set_abs_file_path(file_path)[source] +set_abs_file_path(file_path)[source]
If file_path is relative, make it absolute using DIN_LOC_ROOT.
If an absolute path is input, it is returned unchanged.
- -set_value(name, value)[source] +set_value(name, value)[source]
Set the current value of a given namelist variable.
Usually, you should use add_default instead of this function.
The name argument is the name of the variable to set, and the value @@ -3987,7 +4108,7 @@
Submodules
- -update_shr_strdata_nml(config, stream, stream_path)[source]
+update_shr_strdata_nml(config, stream, stream_path)[source]Updates values for the shr_strdata_nml namelist group.
This should be done once per stream, and it shouldn’t usually be called directly, since create_stream_file calls this method itself.
@@ -3995,25 +4116,25 @@Submodules
- -write_modelio_file(filename)[source]
+write_modelio_file(filename)[source]Write mct component modelio files
- -write_nuopc_config_file(filename, data_list_path=None, sorted_groups=False)[source] +write_nuopc_config_file(filename, data_list_path=None, sorted_groups=False)[source]
Write the nuopc config file
- -write_nuopc_modelio_file(filename)[source] +write_nuopc_modelio_file(filename)[source]
Write nuopc component modelio files
- -write_output_file(namelist_file, data_list_path=None, groups=None, sorted_groups=True)[source] +write_output_file(namelist_file, data_list_path=None, groups=None, sorted_groups=True)[source]
Write out the namelists and input data files.
The namelist_file and modelio_file are the locations to which the component and modelio namelists will be written, respectively. The @@ -4023,7 +4144,7 @@
Submodules
- -write_seq_maps(filename)[source]
+write_seq_maps(filename)[source]Write mct out seq_maps.rc
Submodules -
CIME.provenance module
+CIME.provenance module
Library for saving build/run provenance.
- -CIME.provenance.get_recommended_test_time_based_on_past(baseline_root, test, raw=False)[source] +CIME.provenance.get_recommended_test_time_based_on_past(baseline_root, test, raw=False)[source]
- -CIME.provenance.get_test_success(baseline_root, src_root, test, testing=False)[source] +CIME.provenance.get_test_success(baseline_root, src_root, test, testing=False)[source]
Returns (was prev run success, commit when test last passed, commit when test last transitioned from pass to fail)
Unknown history is expressed as None
- -CIME.provenance.save_test_success(baseline_root, src_root, test, succeeded, force_commit_test=None)[source] +CIME.provenance.save_test_success(baseline_root, src_root, test, succeeded, force_commit_test=None)[source]
Update success data accordingly based on succeeded flag
- -CIME.provenance.save_test_time(baseline_root, test, time_seconds, commit)[source] +CIME.provenance.save_test_time(baseline_root, test, time_seconds, commit)[source]
- CIME.simple_compare module
+CIME.simple_compare module
- -CIME.simple_compare.compare_files(gold_file, compare_file, case=None)[source] +CIME.simple_compare.compare_files(gold_file, compare_file, case=None)[source]
Returns true if files are the same, comments are returned too: (success, comments)
- CIME.test_scheduler module
+CIME.test_scheduler module
A library for scheduling/running through the phases of a set of system tests. Supports phase-level parallelism (can make progres on multiple system tests at once).
@@ -4089,16 +4210,16 @@Submodules
- -class CIME.test_scheduler.TestScheduler(test_names, test_data=None, no_run=False, no_build=False, no_setup=False, no_batch=None, test_root=None, test_id=None, machine_name=None, compiler=None, baseline_root=None, baseline_cmp_name=None, baseline_gen_name=None, clean=False, namelists_only=False, project=None, parallel_jobs=None, walltime=None, proc_pool=None, use_existing=False, save_timing=False, queue=None, allow_baseline_overwrite=False, output_root=None, force_procs=None, force_threads=None, mpilib=None, input_dir=None, pesfile=None, run_count=0, mail_user=None, mail_type=None, allow_pnl=False, non_local=False, single_exe=False, workflow=None, chksum=False, force_rebuild=False)[source]
+class CIME.test_scheduler.TestScheduler(test_names, test_data=None, no_run=False, no_build=False, no_setup=False, no_batch=None, test_root=None, test_id=None, machine_name=None, compiler=None, baseline_root=None, baseline_cmp_name=None, baseline_gen_name=None, clean=False, namelists_only=False, project=None, parallel_jobs=None, walltime=None, proc_pool=None, use_existing=False, save_timing=False, queue=None, allow_baseline_overwrite=False, output_root=None, force_procs=None, force_threads=None, mpilib=None, input_dir=None, pesfile=None, run_count=0, mail_user=None, mail_type=None, allow_pnl=False, non_local=False, single_exe=False, workflow=None, chksum=False, force_rebuild=False)[source]Bases:
object- -run_tests(wait=False, check_throughput=False, check_memory=False, ignore_namelists=False, ignore_memleak=False)[source] +run_tests(wait=False, check_throughput=False, check_memory=False, ignore_namelists=False, ignore_memleak=False)[source]
Main API for this class.
Return True if all tests passed.
Submodules -
CIME.test_status module
+CIME.test_status module
Contains the crucial TestStatus class which manages phase-state of a test case and ensure that this state is represented by the TestStatus file in the case.
@@ -4136,36 +4257,36 @@Submodules
- -class CIME.test_status.TestStatus(test_dir=None, test_name=None, no_io=False)[source]
+class CIME.test_status.TestStatus(test_dir=None, test_name=None, no_io=False)[source]Bases:
object- -get_overall_test_status(wait_for_run=False, check_throughput=False, check_memory=False, ignore_namelists=False, ignore_memleak=False, no_run=False)[source] +get_overall_test_status(wait_for_run=False, check_throughput=False, check_memory=False, ignore_namelists=False, ignore_memleak=False, no_run=False)[source]
Given the current phases and statuses, produce a single results for this test. Preference is given to PEND since we don’t want to stop waiting for a test that hasn’t finished. Namelist diffs are given the lowest precedence.
@@ -4180,7 +4301,9 @@Submodules>>> _test_helper2('PASS ERS.foo.A RUN\nFAIL ERS.foo.A TPUTCOMP') ('PASS', 'RUN') >>> _test_helper2('PASS ERS.foo.A RUN\nFAIL ERS.foo.A TPUTCOMP', check_throughput=True) -('FAIL', 'TPUTCOMP') +('DIFF', 'TPUTCOMP') +>>> _test_helper2('PASS ERS.foo.A RUN\nFAIL ERS.foo.A MEMCOMP', check_memory=True) +('DIFF', 'MEMCOMP') >>> _test_helper2('PASS ERS.foo.A MODEL_BUILD\nPASS ERS.foo.A RUN\nFAIL ERS.foo.A NLCOMP') ('NLFAIL', 'RUN') >>> _test_helper2('PASS ERS.foo.A MODEL_BUILD\nPEND ERS.foo.A RUN\nFAIL ERS.foo.A NLCOMP') @@ -4249,12 +4372,12 @@
Submodules
- -get_status(phase)[source]
+get_status(phase)[source]
- -increment_non_pass_counts(non_pass_counts)[source] +increment_non_pass_counts(non_pass_counts)[source]
Increment counts of the number of times given phases did not pass
non_pass_counts is a dictionary whose keys are phases of interest and whose values are running counts of the number of @@ -4264,7 +4387,7 @@
Submodules
- -phase_statuses_dump(prefix='', skip_passes=False, skip_phase_list=None, xfails=None)[source]
+phase_statuses_dump(prefix='', skip_passes=False, skip_phase_list=None, xfails=None)[source]- Args:
prefix: string printed at the start of each line skip_passes: if True, do not output lines that have a PASS status @@ -4279,7 +4402,7 @@
Submodules
- -set_status(phase, status, comments='')[source]
+set_status(phase, status, comments='')[source]Update the status of this test by changing the status of given phase to the given status.
>>> with TestStatus(test_dir="/", test_name="ERS.foo.A", no_io=True) as ts: @@ -4318,23 +4441,23 @@
Submodules -
CIME.test_utils module
+CIME.test_utils module
Utility functions used in test_scheduler.py, and by other utilities that need to get test lists.
- -CIME.test_utils.get_test_status_files(test_root, compiler, test_id=None)[source] +CIME.test_utils.get_test_status_files(test_root, compiler, test_id=None)[source]
- -CIME.test_utils.get_tests_from_xml(xml_machine=None, xml_category=None, xml_compiler=None, xml_testlist=None, machine=None, compiler=None, driver=None)[source] +CIME.test_utils.get_tests_from_xml(xml_machine=None, xml_category=None, xml_compiler=None, xml_testlist=None, machine=None, compiler=None, driver=None)[source]
Parse testlists for a list of tests
- -CIME.test_utils.test_to_string(test, category_field_width=0, test_field_width=0, show_options=False)[source] +CIME.test_utils.test_to_string(test, category_field_width=0, test_field_width=0, show_options=False)[source]
Given a test dictionary, return a string representation suitable for printing
- Args:
-
@@ -4369,11 +4492,11 @@
- -CIME.user_mod_support.apply_user_mods(caseroot, user_mods_path, keepexe=None)[source] +CIME.user_mod_support.apply_user_mods(caseroot, user_mods_path, keepexe=None)[source]
Recursivlely apply user_mods to caseroot - this includes updating user_nl_xxx, updating SourceMods and creating case shell_commands and xmlchange_cmds files
First remove case shell_commands files if any already exist
@@ -4385,7 +4508,7 @@Submodules
- -CIME.user_mod_support.build_include_dirs_list(user_mods_path, include_dirs=None)[source]
+CIME.user_mod_support.build_include_dirs_list(user_mods_path, include_dirs=None)[source]If user_mods_path has a file “include_user_mods” read that file and add directories to the include_dirs, recursively check each of those directories for further directories. @@ -4394,18 +4517,18 @@
Submodules -
CIME.utils module
+CIME.utils module
Common functions used by cime python scripts Warning: you cannot use CIME Classes in this module as it causes circular dependencies
- -exception CIME.utils.CIMEError[source] +exception CIME.utils.CIMEError[source]
Bases:
SystemExit,Exception
- -class CIME.utils.EnvironmentContext(**kwargs)[source] +class CIME.utils.EnvironmentContext(**kwargs)[source]
Bases:
objectContext manager for environment variables Usage:
@@ -4424,11 +4547,11 @@Submodules
- -class CIME.utils.IndentFormatter(indent, fmt=None, datefmt=None)[source]
+class CIME.utils.IndentFormatter(indent, fmt=None, datefmt=None)[source]Bases:
Formatter- -format(record)[source] +format(record)[source]
Format the specified record as text.
The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. @@ -4444,58 +4567,76 @@
Submodules +class CIME.utils.SharedArea(new_perms=2)[source]
Bases:
objectEnable 0002 umask within this manager
- -class CIME.utils.Timeout(seconds, action=None)[source] +class CIME.utils.Timeout(seconds, action=None)[source]
Bases:
objectA context manager that implements a timeout. By default, it will raise exception, but a custon function call can be provided. Provided None as seconds makes this class a no-op
-
+
- +CIME.utils.add_flag_to_cmd(flag, val)[source] +
Given a flag and value for a shell command, return a string
+++>>> add_flag_to_cmd("-f", "hi") +'-f hi' +>>> add_flag_to_cmd("--foo", 42) +'--foo 42' +>>> add_flag_to_cmd("--foo=", 42) +'--foo=42' +>>> add_flag_to_cmd("--foo:", 42) +'--foo:42' +>>> add_flag_to_cmd("--foo:", " hi ") +'--foo:hi' +
- -CIME.utils.analyze_build_log(comp, log, compiler)[source] +CIME.utils.analyze_build_log(comp, log, compiler)[source]
Capture and report warning count, capture and report errors and undefined references.
- -CIME.utils.append_case_status(phase, status, msg=None, caseroot='.')[source] +CIME.utils.append_case_status(phase, status, msg=None, caseroot='.')[source]
Update CaseStatus file
- -CIME.utils.append_status(msg, sfile, caseroot='.')[source] +CIME.utils.append_status(msg, sfile, caseroot='.')[source]
Append msg to sfile in caseroot
- -CIME.utils.append_testlog(msg, caseroot='.')[source] +CIME.utils.append_testlog(msg, caseroot='.')[source]
Add to TestStatus.log file
- -CIME.utils.check_name(fullname, additional_chars=None, fullpath=False)[source] +CIME.utils.check_name(fullname, additional_chars=None, fullpath=False)[source]
check for unallowed characters in name, this routine only checks the final name and does not check if path exists or is writable
@@ -4519,12 +4660,12 @@Submodules
- -CIME.utils.clear_folder(_dir)[source]
+CIME.utils.clear_folder(_dir)[source]
- -CIME.utils.compute_total_time(job_cost_map, proc_pool)[source] +CIME.utils.compute_total_time(job_cost_map, proc_pool)[source]
Given a map: jobname -> (procs, est-time), return a total time estimate for a given processor pool size
>>> job_cost_map = {"A" : (4, 3000), "B" : (2, 1000), "C" : (8, 2000), "D" : (1, 800)} @@ -4540,12 +4681,12 @@
Submodules
- -CIME.utils.configure_logging(verbose, debug, silent)[source]
+CIME.utils.configure_logging(verbose, debug, silent)[source]- -CIME.utils.convert_to_babylonian_time(seconds)[source] +CIME.utils.convert_to_babylonian_time(seconds)[source]
Convert time value to seconds to HH:MM:SS
>>> convert_to_babylonian_time(3661) '01:01:01' @@ -4557,7 +4698,7 @@
Submodules
- -CIME.utils.convert_to_seconds(time_str)[source]
+CIME.utils.convert_to_seconds(time_str)[source]Convert time value in [[HH:]MM:]SS to seconds
We assume that XX:YY is likely to be HH:MM, not MM:SS
>>> convert_to_seconds("42") @@ -4572,7 +4713,7 @@
Submodules
- -CIME.utils.convert_to_string(value, type_str=None, vid='')[source]
+CIME.utils.convert_to_string(value, type_str=None, vid='')[source]Convert value back to string. vid is only for generating better error messages. >>> convert_to_string(6, type_str=”integer”) == ‘6’ @@ -4587,20 +4728,20 @@
Submodules
- -CIME.utils.convert_to_type(value, type_str, vid='')[source]
+CIME.utils.convert_to_type(value, type_str, vid='')[source]Convert value from string to another type. vid is only for generating better error messages.
- -CIME.utils.convert_to_unknown_type(value)[source] +CIME.utils.convert_to_unknown_type(value)[source]
Convert value to it’s real type by probing conversions.
- -CIME.utils.copy_globs(globs_to_copy, output_directory, lid=None)[source] +CIME.utils.copy_globs(globs_to_copy, output_directory, lid=None)[source]
Takes a list of globs and copies all files to output_directory.
Hiddens files become unhidden i.e. removing starting dot.
Output filename is derviced from the basename of the input path and can @@ -4609,7 +4750,7 @@
Submodules
- -CIME.utils.copy_local_macros_to_dir(destination, extra_machdir=None)[source]
+CIME.utils.copy_local_macros_to_dir(destination, extra_machdir=None)[source]Copy any local macros files to the path given by ‘destination’.
Local macros files are potentially found in: (1) extra_machdir/cmake_macros/.cmake @@ -4618,24 +4759,24 @@
Submodules
- -CIME.utils.copyifnewer(src, dest)[source]
+CIME.utils.copyifnewer(src, dest)[source]if dest does not exist or is older than src copy src to dest
- -CIME.utils.does_file_have_string(filepath, text)[source] +CIME.utils.does_file_have_string(filepath, text)[source]
Does the text string appear in the filepath file
- -CIME.utils.expect(condition, error_msg, exc_type=<class 'CIME.utils.CIMEError'>, error_prefix='ERROR:')[source] +CIME.utils.expect(condition, error_msg, exc_type=<class 'CIME.utils.CIMEError'>, error_prefix='ERROR:')[source]
Similar to assert except doesn’t generate an ugly stacktrace. Useful for checking user error, not programming error.
>>> expect(True, "error1") @@ -4649,32 +4790,32 @@
Submodules
- -CIME.utils.file_contains_python_function(filepath, funcname)[source]
+CIME.utils.file_contains_python_function(filepath, funcname)[source]Checks whether the given file contains a top-level definition of the function ‘funcname’
Returns a boolean value (True if the file contains this function definition, False otherwise)
- -CIME.utils.filter_unicode(unistr)[source] +CIME.utils.filter_unicode(unistr)[source]
Sometimes unicode chars can cause problems
- -CIME.utils.find_files(rootdir, pattern)[source] +CIME.utils.find_files(rootdir, pattern)[source]
recursively find all files matching a pattern
- -CIME.utils.find_proc_id(proc_name=None, children_only=False, of_parent=None)[source] +CIME.utils.find_proc_id(proc_name=None, children_only=False, of_parent=None)[source]
Children implies recursive.
- -CIME.utils.find_system_test(testname, case)[source] +CIME.utils.find_system_test(testname, case)[source]
Find and import the test matching testname Look through the paths set in config_files.xml variable SYSTEM_TESTS_DIR for components used in this case to find a test matching testname. Add the @@ -4684,12 +4825,12 @@
Submodules
- -CIME.utils.fixup_sys_path(*additional_paths)[source]
+CIME.utils.fixup_sys_path(*additional_paths)[source]
- -CIME.utils.format_time(time_format, input_format, input_time)[source] +CIME.utils.format_time(time_format, input_format, input_time)[source]
Converts the string input_time from input_format to time_format Valid format specifiers are “%H”, “%M”, and “%S” % signs must be followed by an H, M, or S and then a separator @@ -4710,17 +4851,17 @@
Submodules
- -CIME.utils.get_all_cime_models()[source]
+CIME.utils.get_all_cime_models()[source]
- -CIME.utils.get_batch_script_for_job(job)[source] +CIME.utils.get_batch_script_for_job(job)[source]
- -CIME.utils.get_charge_account(machobj=None, project=None)[source] +CIME.utils.get_charge_account(machobj=None, project=None)[source]
Hierarchy for choosing CHARGE_ACCOUNT: 1. Environment variable CHARGE_ACCOUNT 2. File $HOME/.cime/config @@ -4743,28 +4884,28 @@
Submodules
- -CIME.utils.get_cime_config()[source]
+CIME.utils.get_cime_config()[source]
- -CIME.utils.get_cime_root(case=None)[source] +CIME.utils.get_cime_root(case=None)[source]
Return the absolute path to the root of CIME that contains this script
- -CIME.utils.get_current_branch(repo=None)[source] +CIME.utils.get_current_branch(repo=None)[source]
Return the name of the current branch for a repository
>>> if "GIT_BRANCH" in os.environ: ... get_current_branch() is not None @@ -4778,7 +4919,7 @@
Submodules
- -CIME.utils.get_current_commit(short=False, repo=None, tag=False)[source]
+CIME.utils.get_current_commit(short=False, repo=None, tag=False)[source]Return the sha1 of the current HEAD commit
>>> get_current_commit() is not None True @@ -4788,7 +4929,7 @@
Submodules
- -CIME.utils.get_current_submodule_status(recursive=False, repo=None)[source]
+CIME.utils.get_current_submodule_status(recursive=False, repo=None)[source]Return the sha1s of the current currently checked out commit for each submodule, along with the submodule path and the output of git describe for the SHA-1.
>>> get_current_submodule_status() is not None @@ -4799,7 +4940,7 @@
Submodules
- -CIME.utils.get_full_test_name(partial_test, caseopts=None, grid=None, compset=None, machine=None, compiler=None, testmods_list=None, testmods_string=None)[source]
+CIME.utils.get_full_test_name(partial_test, caseopts=None, grid=None, compset=None, machine=None, compiler=None, testmods_list=None, testmods_string=None)[source]Given a partial CIME test name, return in form TESTCASE.GRID.COMPSET.MACHINE_COMPILER[.TESTMODS] Use the additional args to fill out the name if needed
Testmods can be provided through one of two arguments, but not both: @@ -4847,7 +4988,7 @@
Submodules
- -CIME.utils.get_htmlroot(
Submodules -
CIME.user_mod_support module
+CIME.user_mod_support module
user_mod_support.py
SubpackagesCIME.tests.test_unit_system_tests module
-
-
Subpackages -
Submodules
+Submodules
- CIME.aprun module
+CIME.aprun module
Aprun is far too complex to handle purely through XML. We need python code to compute and assemble aprun commands.
- CIME.bless_test_results module
+CIME.bless_test_results module
-
+
- CIME.build module
+CIME.build module
functions for building CIME models
- CIME.buildlib module
+CIME.buildlib module
common utilities for buildlib
- CIME.buildnml module
+CIME.buildnml module
common implementation for building namelist commands
These are used by components/<model_type>/<component>/cime_config/buildnml
- CIME.code_checker module
+CIME.code_checker module
Libraries for checking python code with pylint
- CIME.compare_namelists module
+CIME.compare_namelists module
- CIME.compare_test_results module
+CIME.compare_test_results module
- CIME.cs_status module
+CIME.cs_status module
Implementation of the cs.status script, which prints the status of all of the tests in one or more test suites
Subpackages -
Module contents
+Module contents
diff --git a/versions/master/html/CIME_api/CIME.data.templates.html b/versions/master/html/CIME_api/CIME.data.templates.html index ddf13aeac26..e55f7b4ea22 100644 --- a/versions/master/html/CIME_api/CIME.data.templates.html +++ b/versions/master/html/CIME_api/CIME.data.templates.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@- diff --git a/versions/master/html/CIME_api/CIME.html b/versions/master/html/CIME_api/CIME.html index 856416d43df..e4c96a804e4 100644 --- a/versions/master/html/CIME_api/CIME.html +++ b/versions/master/html/CIME_api/CIME.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@CIME.data.templates package
+CIME.data.templates package
- Module contents
+Module contents
- CIME package
+CIME package
- Subpackages
+Subpackages
SubpackagesCIME.tests.test_unit_baselines_performance module
-
+
Subpackages -
Submodules
+Submodules
- CIME.SystemTests.dae module
+CIME.SystemTests.dae module
Implementation of the CIME data assimilation test: Compares standard run with run broken into two data assimilation cycles. Runs a simple DA script on each cycle which performs checks but does not change any model state (restart files). Compares answers of two runs.
Submodules -
CIME.SystemTests.eri module
+CIME.SystemTests.eri module
CIME ERI test This class inherits from SystemTestsCommon
- CIME.SystemTests.err module
+CIME.SystemTests.err module
CIME ERR test This class inherits from ERS ERR tests short term archiving and restart capabilities
- CIME.SystemTests.erri module
+CIME.SystemTests.erri module
CIME ERRI test This class inherits from ERR ERRI tests short term archiving and restart capabilities with “incomplete” (unzipped) log files
- CIME.SystemTests.ers module
+CIME.SystemTests.ers module
CIME restart test This class inherits from SystemTestsCommon
- CIME.SystemTests.hommebaseclass module
+CIME.SystemTests.hommebaseclass module
CIME HOMME test. This class inherits from SystemTestsCommon
- CIME.SystemTests.icp module
+CIME.SystemTests.icp module
CIME ICP test This class inherits from SystemTestsCommon
- CIME.SystemTests.ldsta module
+CIME.SystemTests.ldsta module
CIME last date short term archiver test. This class inherits from SystemTestsCommon It does a run without restarting, then runs the archiver with various last-date parameters The test verifies the archive directory contains the expected files
- CIME.SystemTests.mvk module
+CIME.SystemTests.mvk module
Multivariate test for climate reproducibility using the Kolmogrov-Smirnov (K-S) test and based on The CESM/E3SM model’s multi-instance capability is used to conduct an ensemble of simulations starting from different initial conditions.
This class inherits from SystemTestsCommon.
- CIME.SystemTests.ncr module
+CIME.SystemTests.ncr module
Implementation of the CIME NCR test. This class inherits from SystemTestsCommon
Build two exectuables for this test: The first runs two instances for each component with the same total number of tasks, @@ -517,21 +518,21 @@
Submodules
- CIME.SystemTests.nodefail module
+CIME.SystemTests.nodefail module
CIME restart upon failed node test.
- CIME.SystemTests.pem module
+CIME.SystemTests.pem module
Implementation of the CIME PEM test: Tests bfb with different MPI processor counts
This is just like running a smoke test twice - but the pe-counts @@ -563,35 +564,35 @@
Submodules
- CIME.SystemTests.pet module
+CIME.SystemTests.pet module
Implementation of the CIME PET test. This class inherits from SystemTestsCommon
This is an openmp test to determine that changing thread counts does not change answers. (1) do an initial run where all components are threaded by default (suffix: base) (2) do another initial run with nthrds=1 for all components (suffix: single_thread)
- CIME.SystemTests.pfs module
+CIME.SystemTests.pfs module
CIME performance test This class inherits from SystemTestsCommon
20 days performance test, no restart files written
- CIME.SystemTests.restart_tests module
+CIME.SystemTests.restart_tests module
Abstract class for restart tests
- CIME.SystemTests.reuseinitfiles module
+CIME.SystemTests.reuseinitfiles module
Implementation of the CIME REUSEINITFILES test
This test does two runs:
- CIME.SystemTests.seq module
+CIME.SystemTests.seq module
sequencing bfb test (10 day seq,conc tests)
- CIME.SystemTests.sms module
+CIME.SystemTests.sms module
CIME smoke test This class inherits from SystemTestsCommon It does a startup run with restarts off and optionally compares to or generates baselines
- CIME.SystemTests.system_tests_common module
+CIME.SystemTests.system_tests_common module
Base class for CIME system tests
- diff --git a/versions/master/html/CIME_api/CIME.SystemTests.test_utils.html b/versions/master/html/CIME_api/CIME.SystemTests.test_utils.html index 826f056d341..98b53b1bf3e 100644 --- a/versions/master/html/CIME_api/CIME.SystemTests.test_utils.html +++ b/versions/master/html/CIME_api/CIME.SystemTests.test_utils.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@CIME.SystemTests.system_tests_compare_n module
+CIME.SystemTests.system_tests_compare_n module
Base class for CIME system tests that involve doing multiple runs and comparing the base run (index=0) with the subsequent runs (indices=1..N-1).
NOTE: Below is the flow of a multisubmit test. @@ -1101,11 +1107,11 @@
Submodules
- diff --git a/versions/master/html/CIME_api/CIME.Tools.html b/versions/master/html/CIME_api/CIME.Tools.html index 706f867c0e0..a5fc65364ce 100644 --- a/versions/master/html/CIME_api/CIME.Tools.html +++ b/versions/master/html/CIME_api/CIME.Tools.html @@ -12,11 +12,11 @@ - - - - - + + + + + @@ -66,6 +66,7 @@CIME.SystemTests.test_utils package
+CIME.SystemTests.test_utils package
- Submodules
+Submodules
- CIME.SystemTests.test_utils.user_nl_utils module
+CIME.SystemTests.test_utils.user_nl_utils module
This module contains functions for working with user_nl files in system tests.
- CIME.Tools package
+CIME.Tools package
- Submodules
+Submodules
- CIME.Tools.generate_cylc_workflow module
+CIME.Tools.generate_cylc_workflow module
Generates a cylc workflow file for the case. See https://cylc.github.io for details about cylc
- CIME.Tools.standard_script_setup module
+CIME.Tools.standard_script_setup module
Encapsulate the importing of python utils and logging setup, things that every script should do.