From 3940a59c7c8abb939cd2fe452461df7a45070820 Mon Sep 17 00:00:00 2001 From: apcraig Date: Wed, 15 Mar 2023 13:04:21 -0600 Subject: [PATCH 1/5] update documentation --- doc/source/developer_guide/dg_col_phys.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/developer_guide/dg_col_phys.rst b/doc/source/developer_guide/dg_col_phys.rst index 8ebc62c59..ba2d12715 100755 --- a/doc/source/developer_guide/dg_col_phys.rst +++ b/doc/source/developer_guide/dg_col_phys.rst @@ -84,7 +84,7 @@ Overall, columnphysics changes in the Icepack model should include the following * All modules should have the following set at the top - .. code-block:: fortran + .. code-block:: implicit none private @@ -93,13 +93,13 @@ Overall, columnphysics changes in the Icepack model should include the following * All subroutines and functions should define the subname character parameter statement to match the interface name like - .. code-block:: fortran + .. code-block:: character(len=*),parameter :: subname='(lateral_melt_bgc)' * All interfaces that are public outside the Icepack columnphysics should include autodocument_start and autodocument_end comment lines with appropriate syntax and location. If any interfaces are added or updated, then the internal documentation should be updated via - .. code-block:: bash + .. code-block:: ./icepack.setup --docintfc @@ -107,13 +107,13 @@ Overall, columnphysics changes in the Icepack model should include the following * The icepack_warnings package should be used to cache log messages and set the abort flag. To add a log message, use icepack_warnings_add like - .. code-block:: fortran + .. code-block:: call icepack_warnings_add(subname//' algorithm did not converge') To formally set the abort flag, use - .. code-block:: fortran + .. code-block:: call icepack_warnings_setabort(.true.,__FILE__,__LINE__) @@ -121,7 +121,7 @@ Overall, columnphysics changes in the Icepack model should include the following * Every interface call within the columnphysics should be followed by - .. code-block:: fortran + .. code-block:: if (icepack_warnings_aborted(subname)) return @@ -141,7 +141,7 @@ Overall, columnphysics changes in the Icepack model should include the following * An example of how this might look is - .. code-block:: fortran + .. code-block:: use icepack_parameters, only: flag_arg2, flag_arg3 From afa1c287ae2a05a1b52e66dbe6f8b03af8957697 Mon Sep 17 00:00:00 2001 From: apcraig Date: Wed, 15 Mar 2023 13:12:48 -0600 Subject: [PATCH 2/5] update documentation --- doc/source/developer_guide/dg_col_phys.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/source/developer_guide/dg_col_phys.rst b/doc/source/developer_guide/dg_col_phys.rst index ba2d12715..9b1aec317 100755 --- a/doc/source/developer_guide/dg_col_phys.rst +++ b/doc/source/developer_guide/dg_col_phys.rst @@ -47,6 +47,7 @@ The column physics source code contains the following files | **icepack_zsalinity.F90** vertical salinity parameterization of :cite:`Jeffery11` + Coding Standard ------------------------------------ @@ -84,7 +85,7 @@ Overall, columnphysics changes in the Icepack model should include the following * All modules should have the following set at the top - .. code-block:: + .. code-block:: fortran implicit none private @@ -93,13 +94,13 @@ Overall, columnphysics changes in the Icepack model should include the following * All subroutines and functions should define the subname character parameter statement to match the interface name like - .. code-block:: + .. code-block:: fortran character(len=*),parameter :: subname='(lateral_melt_bgc)' * All interfaces that are public outside the Icepack columnphysics should include autodocument_start and autodocument_end comment lines with appropriate syntax and location. If any interfaces are added or updated, then the internal documentation should be updated via - .. code-block:: + .. code-block:: bash ./icepack.setup --docintfc @@ -107,13 +108,13 @@ Overall, columnphysics changes in the Icepack model should include the following * The icepack_warnings package should be used to cache log messages and set the abort flag. To add a log message, use icepack_warnings_add like - .. code-block:: + .. code-block:: fortran call icepack_warnings_add(subname//' algorithm did not converge') To formally set the abort flag, use - .. code-block:: + .. code-block:: fortran call icepack_warnings_setabort(.true.,__FILE__,__LINE__) @@ -121,7 +122,7 @@ Overall, columnphysics changes in the Icepack model should include the following * Every interface call within the columnphysics should be followed by - .. code-block:: + .. code-block:: fortran if (icepack_warnings_aborted(subname)) return @@ -141,7 +142,7 @@ Overall, columnphysics changes in the Icepack model should include the following * An example of how this might look is - .. code-block:: + .. code-block:: fortran use icepack_parameters, only: flag_arg2, flag_arg3 From 2c599f6a80a2c913d1edd2de905db6a0616c9f16 Mon Sep 17 00:00:00 2001 From: apcraig Date: Wed, 15 Mar 2023 13:45:40 -0600 Subject: [PATCH 3/5] update documentation --- README.md | 1 + doc/source/developer_guide/dg_col_phys.rst | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7535233a3..29cf69891 100644 --- a/README.md +++ b/README.md @@ -43,3 +43,4 @@ Head over to our [Contributing][contributing] guide to learn more about how you ## License See our [License](LICENSE.pdf) and [Distribution Policy](DistributionPolicy.pdf). + diff --git a/doc/source/developer_guide/dg_col_phys.rst b/doc/source/developer_guide/dg_col_phys.rst index 9b1aec317..8ebc62c59 100755 --- a/doc/source/developer_guide/dg_col_phys.rst +++ b/doc/source/developer_guide/dg_col_phys.rst @@ -47,7 +47,6 @@ The column physics source code contains the following files | **icepack_zsalinity.F90** vertical salinity parameterization of :cite:`Jeffery11` - Coding Standard ------------------------------------ From 33d256cc0797dbb78c3efec9484c4c5fc6077e0d Mon Sep 17 00:00:00 2001 From: apcraig Date: Wed, 15 Mar 2023 14:17:38 -0600 Subject: [PATCH 4/5] update documentation --- doc/source/science_guide/sg_snow.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/science_guide/sg_snow.rst b/doc/source/science_guide/sg_snow.rst index 7b0ea3dce..3b8db8a77 100755 --- a/doc/source/science_guide/sg_snow.rst +++ b/doc/source/science_guide/sg_snow.rst @@ -73,8 +73,8 @@ where :math:`\rho_s` and :math:`\rho_{max}` are the effective snow density and t :math:`\Phi_E \Delta t` represents the maximum snow mass per unit area that may be suspended from each category, subject to the total mass (per unit area) available on each category. -Erosion begins when the instantaneous wind speed :math:`V` exceeds the seasonal wind speed required to compact the snow to a density :math:`\rho_s`, :math:`V^* = (\rho_s − \beta)/\alpha`. :math:`\sigma_{ITD}` is the standard deviation of the ice thicknesses from the thickness distribution :math:`g` within the grid cell. :math:`\gamma` is a tuning coefficient for -the eroded mass, which :cite:`Lecomte15` set to :math:`10^{-5}` kg m :math:`^{-2}`. From :cite:`Lecomte13`, :math:`\rho_s = 44.6V^* + 174` kg m :math:`^{−3}` for seasonal mean wind speed :math:`V`, i.e. :math:`\alpha=174` kg m :math:`^{-3}` and :math:`\beta=44.6` kg s m :math:`^{-4}`. +Erosion begins when the instantaneous wind speed :math:`V` exceeds the seasonal wind speed required to compact the snow to a density :math:`\rho_s`, :math:`V^* = (\rho_s - \beta)/\alpha`. :math:`\sigma_{ITD}` is the standard deviation of the ice thicknesses from the thickness distribution :math:`g` within the grid cell. :math:`\gamma` is a tuning coefficient for +the eroded mass, which :cite:`Lecomte15` set to :math:`10^{-5}` kg m :math:`^{-2}`. From :cite:`Lecomte13`, :math:`\rho_s = 44.6V^* + 174` kg m :math:`^{-3}` for seasonal mean wind speed :math:`V`, i.e. :math:`\alpha=174` kg m :math:`^{-3}` and :math:`\beta=44.6` kg s m :math:`^{-4}`. In :cite:`Lecomte15`, the fraction of this suspended snow lost in leads is From 1ebe9b9c9ae73c4d9d60dbf6abf3d131843d5007 Mon Sep 17 00:00:00 2001 From: apcraig Date: Wed, 15 Mar 2023 14:26:57 -0600 Subject: [PATCH 5/5] update documentation --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 29cf69891..7535233a3 100644 --- a/README.md +++ b/README.md @@ -43,4 +43,3 @@ Head over to our [Contributing][contributing] guide to learn more about how you ## License See our [License](LICENSE.pdf) and [Distribution Policy](DistributionPolicy.pdf). -