From 2c4cb3d630fdea6639ba593d0a3429689114d0d1 Mon Sep 17 00:00:00 2001 From: Samuel Levis Date: Wed, 27 May 2026 09:51:51 -0600 Subject: [PATCH 1/4] Remove section 1.4.3.1 What are the required files? --- .../Adding-or-Changing-Default-Filenames.rst | 14 -------------- .../observational-sites-datasets.rst | 7 ++----- 2 files changed, 2 insertions(+), 19 deletions(-) diff --git a/doc/source/users_guide/adding-new-resolutions/Adding-or-Changing-Default-Filenames.rst b/doc/source/users_guide/adding-new-resolutions/Adding-or-Changing-Default-Filenames.rst index a39ffa9426..47cbad9dc6 100644 --- a/doc/source/users_guide/adding-new-resolutions/Adding-or-Changing-Default-Filenames.rst +++ b/doc/source/users_guide/adding-new-resolutions/Adding-or-Changing-Default-Filenames.rst @@ -17,17 +17,3 @@ To add or change the default filenames you edit the ``$CTSMROOT/bld/namelist_fil Other ``fsurdat`` files are distinguished from this one by their resolution (``hgrid``), simulation year (``sim_year``) and prognostic crop (``use_crop``) attributes. ----------------------------- -What are the required files? ----------------------------- - -Different types of simulations and different types of configurations for CLM require different lists of files. The |version|-BGC or Carbon Nitrogen (cn) Biogeochemistry model for example requires ``stream_fldfilename_ndep`` files, which are NOT required by CLMSP. Transient simulations also require transient datasets, and the names of these datasets are sometimes different from the static versions (sometimes both are required as in the dynamic PFT cases). - -In the following table we list the different files used by CLM, they are listed in order of importance, dependencies, and customizing. So the required files are all near the top, and the files used only under different conditions are listed later, and files with the fewest dependencies are near the top, as are the files that are least likely to be customized. - -.. _reqd-files-table: - -Table 3-1. Required Files for Different Configurations and Simulation Types ---------------------------------------------------------------------------- -.. todo:: - Insert table 3-1 diff --git a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst index 71f4783b92..df214f828b 100644 --- a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst +++ b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst @@ -6,9 +6,6 @@ Observational Sites Datasets ******************************* -.. todo:: - Update this. +There are two ways to customize datasets for a particular observational site. The first is to customize the input to the tools that create the dataset, and the second is to overwrite the default data after you've created a given dataset. Depending on the tool it might be easier to do it one way or the other. Files that you may customize include ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. To generate custom ``fsurdat`` files, you may modify the inputs needed by the ``mksurfdata_esmf`` tool. Also see :ref:`generic_single_point_runs` for relevant information pertaining to single-point simuations. -There are two ways to customize datasets for a particular observational site. The first is to customize the input to the tools that create the dataset, and the second is to overwrite the default data after you've created a given dataset. Depending on the tool it might be easier to do it one way or the other. In Table :numref:`reqd-files-table` we list the files that are most likely to be customized and the way they might be customized. Of those files, the ones you are most likely to customize are: ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. Note ``mksurfdata_esmf`` as documented previously has options to overwrite the vegetation and soil types. For more information on this also see :ref:`generic_single_point_runs`. - -Another aspect of customizing your input datasets is customizing the input atmospheric forcing datasets; see :ref:`generic_single_point_runs` for more information on this. +Another aspect of customizing your input datasets is customizing the input atmospheric forcing datasets; see :ref:`generic_single_point_runs` for information on this. From 234f628658afe0ba08a3b99c7b95f849529edf07 Mon Sep 17 00:00:00 2001 From: Samuel Levis Date: Wed, 27 May 2026 11:43:25 -0600 Subject: [PATCH 2/4] Updates to section 1.3.5 Observational Sites Datasets --- .../using-clm-tools/observational-sites-datasets.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst index df214f828b..1ef66c621e 100644 --- a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst +++ b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst @@ -6,6 +6,8 @@ Observational Sites Datasets ******************************* -There are two ways to customize datasets for a particular observational site. The first is to customize the input to the tools that create the dataset, and the second is to overwrite the default data after you've created a given dataset. Depending on the tool it might be easier to do it one way or the other. Files that you may customize include ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. To generate custom ``fsurdat`` files, you may modify the inputs needed by the ``mksurfdata_esmf`` tool. Also see :ref:`generic_single_point_runs` for relevant information pertaining to single-point simuations. +A way to customize the model input datasets for single-point simulations is to customize the inputs to the tools that create the datasets. Another way is to overwrite the data after you have generated the datasets with default inputs. Depending on the tool and the dataset, one way or the other may be simpler. + +Files that you may customize include ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. Though generally to customize ``fsurdat`` files, you could modify the inputs needed by the ``mksurfdata_esmf`` tool, for single-point simulations we recommend a different method in :ref:`generic_single_point_runs`. Another aspect of customizing your input datasets is customizing the input atmospheric forcing datasets; see :ref:`generic_single_point_runs` for information on this. From 9fa77e323f09a2c0711d9f47404cd9e0bca0abec Mon Sep 17 00:00:00 2001 From: Samuel Levis Date: Wed, 27 May 2026 11:14:23 -0700 Subject: [PATCH 3/4] Update doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst More updates to paragraph 1 of section 1.3.5 --- .../using-clm-tools/observational-sites-datasets.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst index 1ef66c621e..8099739505 100644 --- a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst +++ b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst @@ -6,7 +6,7 @@ Observational Sites Datasets ******************************* -A way to customize the model input datasets for single-point simulations is to customize the inputs to the tools that create the datasets. Another way is to overwrite the data after you have generated the datasets with default inputs. Depending on the tool and the dataset, one way or the other may be simpler. +A way to customize the model input datasets is to customize the inputs to the tools that create the datasets. One can also overwrite the data of already generated datasets. Depending on the tool, the dataset, and the planned simulation, one way or the other may be simpler, or a combination of both methods may make sense. Files that you may customize include ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. Though generally to customize ``fsurdat`` files, you could modify the inputs needed by the ``mksurfdata_esmf`` tool, for single-point simulations we recommend a different method in :ref:`generic_single_point_runs`. From 74afdf6e91f2f8cfa8ba630aff645d6b3bf17554 Mon Sep 17 00:00:00 2001 From: Samuel Levis Date: Wed, 27 May 2026 11:14:44 -0700 Subject: [PATCH 4/4] Update doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst More updates to paragraph 2 of section 1.3.5 --- .../using-clm-tools/observational-sites-datasets.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst index 8099739505..54c48e5e03 100644 --- a/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst +++ b/doc/source/users_guide/using-clm-tools/observational-sites-datasets.rst @@ -8,6 +8,6 @@ Observational Sites Datasets A way to customize the model input datasets is to customize the inputs to the tools that create the datasets. One can also overwrite the data of already generated datasets. Depending on the tool, the dataset, and the planned simulation, one way or the other may be simpler, or a combination of both methods may make sense. -Files that you may customize include ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. Though generally to customize ``fsurdat`` files, you could modify the inputs needed by the ``mksurfdata_esmf`` tool, for single-point simulations we recommend a different method in :ref:`generic_single_point_runs`. +Files that you may customize include ``fatmlndfrc``, ``fsurdat``, ``faerdep`` (for DATM), and ``stream_fldfilename_ndep``. To customize ``fsurdat`` files, one may modify the inputs needed by the ``mksurfdata_esmf`` tool. In addition (or instead) we strongly recommend using the ``subset_data`` tool for single-point and regional simulations (see :ref:`generic_single_point_runs`). A combination of methods may make the most sense in some cases. Another aspect of customizing your input datasets is customizing the input atmospheric forcing datasets; see :ref:`generic_single_point_runs` for information on this.