Skip to content

Commit

Permalink
No release notes in docs (use Github); update links
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertPincus committed Feb 20, 2025
1 parent 58d2dce commit a26f0c9
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 84 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/doc-deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -79,12 +79,12 @@ 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
if: ${{ github.event_name == 'push' && github.ref != 'refs/heads/main' }}
with:
branch: gh-pages
folder: public/
target_folder: staging/
target-folder: staging/
16 changes: 0 additions & 16 deletions doc/jekyll_site/_posts/2022-06-02-Release-notes.md

This file was deleted.

15 changes: 0 additions & 15 deletions doc/jekyll_site/_posts/2023-11-27-v1.7-Release-notes.md

This file was deleted.

23 changes: 0 additions & 23 deletions doc/jekyll_site/_posts/2024-05-20-v1.8-Release-notes.md

This file was deleted.

21 changes: 0 additions & 21 deletions doc/jekyll_site/_posts/2025-01-28-v1.9-Release-notes.md

This file was deleted.

6 changes: 3 additions & 3 deletions doc/jekyll_site/explanations/rte-fluxes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions doc/jekyll_site/explanations/rte-optical-props.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/jekyll_site/explanations/rte-solvers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.`

Expand Down

0 comments on commit a26f0c9

Please sign in to comment.