diff --git a/.github/workflows/doc-deployment.yml b/.github/workflows/doc-deployment.yml index 85258a96b..369020fec 100644 --- a/.github/workflows/doc-deployment.yml +++ b/.github/workflows/doc-deployment.yml @@ -69,7 +69,7 @@ jobs: RECURSIVE: true ASSIGNEES: ${{ github.actor }} # - # Deploy documentation (can add target_folder) + # Deploy documentation (can add target-folder) # - name: Deploy to Github Pages root uses: JamesIves/github-pages-deploy-action@v4.7.2 @@ -79,7 +79,7 @@ jobs: folder: public/ # - # Deploy documentation (can add target_folder) + # Deploy documentation (can add target-folder) # - name: Deploy to Github Pages root uses: JamesIves/github-pages-deploy-action@v4.7.2 @@ -87,4 +87,4 @@ jobs: with: branch: gh-pages folder: public/ - target_folder: staging/ + target-folder: staging/ diff --git a/doc/jekyll_site/_posts/2022-06-02-Release-notes.md b/doc/jekyll_site/_posts/2022-06-02-Release-notes.md deleted file mode 100644 index 3d9c78a70..000000000 --- a/doc/jekyll_site/_posts/2022-06-02-Release-notes.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: post -title: '2022-06-02: Release notes' -categories: Release-notes ---- - -Commit [a4fe30c](https://github.com/earth-system-radiation/rte-rrtmgp/commit/a4fe30cf4dab2e5fd8d3ab6f11683a82ae584475) -to branch `main` makes the following changes: - -- Solar zenith angle can vary with height, allowing for calculations on a pseudo-spherical earth -- New documentation site, partly hand-written (still essentially empty) and partly auto-generated from comments in code (partly complete). -- Workaround for Intel compilers on specific AMD processors -- Python dependencies made explicit in environment.yml files -- Move from wget to Python for downloading files in testing -- Public visibility and C-bindings restricted to just a few kernels -- Assorted consistency and prettifying diff --git a/doc/jekyll_site/_posts/2023-11-27-v1.7-Release-notes.md b/doc/jekyll_site/_posts/2023-11-27-v1.7-Release-notes.md deleted file mode 100644 index 3eb550cf1..000000000 --- a/doc/jekyll_site/_posts/2023-11-27-v1.7-Release-notes.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: post -title: v1.7 Release notes -categories: Release-notes ---- - -Commit [3ac0636](https://github.com/earth-system-radiation/rte-rrtmgp/commit/3ac0636b17d6a3f11e4085f91679393fceaa4e18) -to branch `main` makes the following changes: - -- Libraries can be built in single precision by changes in `rte-kind/mo_rte_kind.F90`. Differences with respect to double precision are roughly 0.13 W/m2. -- A class for computing the optical properties of aerosols following the MERRA representation has been added. -- The repository is reorganized into `frontend` and `kernel` directories for `rte` and `rrtmgp`. Data has been moved to a separate \[repository\]((https://github.com/earth-system-radiation/rrtmgp-data/). -- Citation information has been added. - -As usual some bugs have been fixed, the use of OpenACC and OpenMP GPU offload directives continues to evolve, and the continous integration continues to be fine-tuned. diff --git a/doc/jekyll_site/_posts/2024-05-20-v1.8-Release-notes.md b/doc/jekyll_site/_posts/2024-05-20-v1.8-Release-notes.md deleted file mode 100644 index 2a64be5e0..000000000 --- a/doc/jekyll_site/_posts/2024-05-20-v1.8-Release-notes.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: post -title: v1.8 Release notes -categories: Release-notes ---- - -Accumulated changes and bug fixes. Changes LW answers (data repo is also updated). - -- New LW weights and secants (Change LW quadrature angles #282) -- A single source function on levels (Simplify LW source functions #250) -- Kernel API header files in Fortran and C (Add kernel API #272) -- Refactored two-stream, fixing RTE shortwave kernel not vectorizing #215 (Re-vectorize SW two-stream #275) -- Buxfixes, change to internal build systems and continuous integration (thanks to @skosukhin for ongoing help) - -What's Changed - -- Deploy documentation from separate branch by @RobertPincus in #246 -- CI should fail when individual tests fail by @RobertPincus in #256 -- Backport Levante CI by @skosukhin in #257 -- Backport Levante CI with NAG by @skosukhin in #260 -- Backport the intent fix in lw_transport_noscat_up by @skosukhin in #262 -- Reduce use of CI via manual runs by @RobertPincus in #264 -- Refactored two-stream, new LW source functions and quadrature, kernel API by @RobertPincus in #284 diff --git a/doc/jekyll_site/_posts/2025-01-28-v1.9-Release-notes.md b/doc/jekyll_site/_posts/2025-01-28-v1.9-Release-notes.md deleted file mode 100644 index f27b7cace..000000000 --- a/doc/jekyll_site/_posts/2025-01-28-v1.9-Release-notes.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: post -title: v1.9 Release notes -categories: Release-notes ---- - -Release [v1.9](https://github.com/earth-system-radiation/rte-rrtmgp/releases/tag/v1.9) makes the following user-facing changes: - -- Adopts the `CMake` build system -- Vertical directionality (`top_at_1`) is encapsulated within the arrays of optical properties rather than carried as an indepdent variable. -- Cloud optical properties may be computed by-band (as before) or by g-point. New data is provided to allow computations by g-point. -- Ice sizes are labled to make clear they are diameter, not radius - -As usual there are minor fixes and enhancements. Sergy Kosukhin of the Max Planck Institute for Meteorology refined an initial CMake implementaion -by Makepath LLC. Sergy also keeps the continuous integration humming smoothly. - -Development to this point has followed the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow); -starting with this release we're going to move instead to a single protected `main` branch and short-lived development branches. -This will include removing the `develop` and `documentation` branches. - -The RTE+RRTMGP libraries and data are now distributed via `conda-forge` thanks to work by Makepath LLC. diff --git a/doc/jekyll_site/explanations/rte-fluxes.md b/doc/jekyll_site/explanations/rte-fluxes.md index b51b5fdf9..0fe285c29 100644 --- a/doc/jekyll_site/explanations/rte-fluxes.md +++ b/doc/jekyll_site/explanations/rte-fluxes.md @@ -3,17 +3,17 @@ layout: page title: RTE - fluxes --- -RTE solves the radiative transfer equation for each spectral point independently but this detailed information typically isn't useful. Class `ty_fluxes` in module `[mo_fluxes](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/module/mo_fluxes.html)` in the RTE library provides a way to reduce the highly-detailed information based on precisely what the user needs. Class `ty_fluxes_broadband` provides an example implementation that reports broadband flux i.e. the sum over all spectral points at all levels. +RTE solves the radiative transfer equation for each spectral point independently but this detailed information typically isn't useful. Class `ty_fluxes` in module [mo_fluxes](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/module/mo_fluxes.html) in the RTE library provides a way to reduce the highly-detailed information based on precisely what the user needs. Class `ty_fluxes_broadband` provides an example implementation that reports broadband flux i.e. the sum over all spectral points at all levels. # Fluxes interface -`[ty_fluxes](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/type/ty_fluxes.html)` is an abstract class that defines [two interfaces](/reference/rte-fortran-interface/type/ty_fluxes.html) defining type-bound functions. Function `reduce` is called within the RTE solvers. The input arguments include the spectrally-resolved fluxes up and down (and, optically, the direct-beam flux) and the spectral discretization. Logical function `are_desired` is called by RTE to check if the results of a calculation will be used. +`[ty_fluxes](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/type/ty_fluxes.html)` is an abstract class that defines [two interfaces](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/type/ty_fluxes.html) defining type-bound functions. Function `reduce` is called within the RTE solvers. The input arguments include the spectrally-resolved fluxes up and down (and, optically, the direct-beam flux) and the spectral discretization. Logical function `are_desired` is called by RTE to check if the results of a calculation will be used. Class `ty_fluxes` is abstract; it defines only the interfaces to these routines. Implementation is deferred to user classes that extend this class. # Broadband fluxes -Class `[ty_fluxes_broadband](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/type/ty_fluxes_broadband.html)` in the same [module](/reference/rte-fortran-interface/module/mo_fluxes.html) provides an example of how to extend `ty_fluxes`. This class reports broadband values i.e. the sum over every element in the spectral dimensions. The class contains [four data fields](/reference/rte-fortran-interface/type/ty_fluxes_broadband.html). Before calling one of the RTE solvers with this class as output, users either allocate one or more of these output fields or point to an existing array. The fields must have the same number of columns and layers as the problem being solved. In class `ty_fluxes_broadband` logical function \`are_desired()\`\` returns true if one or more of the data fields points to storage and false otherwise. +Class [ty_fluxes_broadband](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/type/ty_fluxes_broadband.html) in the same [module](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/module/mo_fluxes.html) provides an example of how to extend `ty_fluxes`. This class reports broadband values i.e. the sum over every element in the spectral dimensions. The class contains [four data fields](https://earth-system-radiation.github.io/rte-rrtmgp/reference/rte-fortran-interface/type/ty_fluxes_broadband.html). Before calling one of the RTE solvers with this class as output, users either allocate one or more of these output fields or point to an existing array. The fields must have the same number of columns and layers as the problem being solved. In class `ty_fluxes_broadband` logical function \`are_desired()\`\` returns true if one or more of the data fields points to storage and false otherwise. # Other extensions diff --git a/doc/jekyll_site/explanations/rte-optical-props.md b/doc/jekyll_site/explanations/rte-optical-props.md index dcb1d177a..c00947ca9 100644 --- a/doc/jekyll_site/explanations/rte-optical-props.md +++ b/doc/jekyll_site/explanations/rte-optical-props.md @@ -7,9 +7,9 @@ title: RTE - optical properties The spectral properties of the atmosphere and the source functions depend on electromagnetic wavelength (or frequency or wavenumber). RTE treats this spectral dependence by dividing the spectrum into one or more _bands_, each of which represents a continuous set of wavelengths/frequencies/wavenumbers. Bands may be further sub-divided into _g-points_ (the language is borrowed from _k_-distributions). Each _g_-point is treated as a independent psudo-monchromatic calculation but there is no inherent mapping between _g_-points and wavelengths; the sum over _g_-points is the band-average value. -Bands are defined by their bounds, expressed as wavenumbers in cm$^{-1}$, and by their staring and ending (integer) g-points. A spectral discretization defined only on bands is represented with one _g_-point per band. A set of monochromatic caclulations may be represented by additionally setting the upper and lower wavenumbers for each band to the same value. +Bands are defined by their bounds, expressed as wavenumbers in 1/cm-1}\$, and by their staring and ending (integer) g-points. A spectral discretization defined only on bands is represented with one _g_-point per band. A set of monochromatic caclulations may be represented by additionally setting the upper and lower wavenumbers for each band to the same value. -Class `ty_optical_props` implements a range of [procedures](/reference/optical-props-overview.html) for representing and manipulating the spectral discretization. These capabilities are inherited by classes that represent arrays of optical properties (i.e. optical depth) or sources of radiation and by those used to compute optical properties from a physical description of the atmosphere. +Class `ty_optical_props` implements a range of [procedures](https://earth-system-radiation.github.io/rte-rrtmgp/reference/optical-props-overview.html) for representing and manipulating the spectral discretization. These capabilities are inherited by classes that represent arrays of optical properties (i.e. optical depth) or sources of radiation and by those used to compute optical properties from a physical description of the atmosphere. # RRTMGP's spectral discretization diff --git a/doc/jekyll_site/explanations/rte-solvers.md b/doc/jekyll_site/explanations/rte-solvers.md index 1b54db41a..620262a97 100644 --- a/doc/jekyll_site/explanations/rte-solvers.md +++ b/doc/jekyll_site/explanations/rte-solvers.md @@ -3,7 +3,7 @@ layout: page title: RTE - solvers --- -The `[rte_lw()](/reference/rte-fortran-interface/proc/rte_lw.html)` and `[rte_sw()](/reference/rte-fortran-interface/proc/rte_sw.html)` routines in the RTE library compute radiative transfer on a user-specified problem. Both routines allow for an upper boundary condition for spectrally-resolved diffuse radiation. `rte_sw()` is overloaded to allow users to specify either a single value of `mu0` per column or a value at each layer of each column. +The [rte_lw()](/reference/rte-fortran-interface/proc/rte_lw.html) and [rte_sw()](/reference/rte-fortran-interface/proc/rte_sw.html) routines in the RTE library compute radiative transfer on a user-specified problem. Both routines allow for an upper boundary condition for spectrally-resolved diffuse radiation. `rte_sw()` is overloaded to allow users to specify either a single value of `mu0` per column or a value at each layer of each column. If optical properties are specified as variables of type ty_optical_props_1scl (meaning extinction optical depth alone) in the longwave, radiative transfer is computed accounting for only emission and absorption. If optical properties are specified as variables of type `ty_optical_props_2str` (optical depth, single-scattering albedo, and asymmetry parameter) the rescaling and refinement method of [Tang et al. 2018](https://doi.org/10.1175/JAS-D-18-0014.1) is used by default; two-stream and adding methods maybe be chosen by setting optional argument `use_2stream` to `.TRUE.`