Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4d8c5df 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertPincus committed Nov 28, 2023
1 parent 7444d8d commit 4a4693a
Show file tree
Hide file tree
Showing 102 changed files with 41,205 additions and 822 deletions.
12 changes: 11 additions & 1 deletion feed.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.2.2">Jekyll</generator><link href="https://earth-system-radiation.github.io//rte-rrtmgp/feed.xml" rel="self" type="application/atom+xml" /><link href="https://earth-system-radiation.github.io//rte-rrtmgp/" rel="alternate" type="text/html" /><updated>2023-11-27T21:16:53+00:00</updated><id>https://earth-system-radiation.github.io//rte-rrtmgp/feed.xml</id><title type="html">RTE-RRTMGP</title><subtitle>RTE+RRTMGP is a set of codes for computing radiative fluxes in planetary atmospheres. RRTMGP uses a k-distribution to provide an optical description (absorption and possibly Rayleigh optical depth) of the gaseous atmosphere, along with the relevant source functions, on a pre-determined spectral grid given temperatures, pressures, and gas concentration. RTE computes fluxes given spectrally-resolved optical descriptions and source functions.</subtitle><entry><title type="html">2022-06-02: Release notes</title><link href="https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2022/06/02/Release-notes.html" rel="alternate" type="text/html" title="2022-06-02: Release notes" /><published>2022-06-02T00:00:00+00:00</published><updated>2022-06-02T00:00:00+00:00</updated><id>https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2022/06/02/Release-notes</id><content type="html" xml:base="https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2022/06/02/Release-notes.html"><![CDATA[<p>Commit <a href="https://github.com/earth-system-radiation/rte-rrtmgp/commit/a4fe30cf4dab2e5fd8d3ab6f11683a82ae584475">a4fe30c</a>
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.2.2">Jekyll</generator><link href="https://earth-system-radiation.github.io//rte-rrtmgp/feed.xml" rel="self" type="application/atom+xml" /><link href="https://earth-system-radiation.github.io//rte-rrtmgp/" rel="alternate" type="text/html" /><updated>2023-11-28T02:25:58+00:00</updated><id>https://earth-system-radiation.github.io//rte-rrtmgp/feed.xml</id><title type="html">RTE-RRTMGP</title><subtitle>RTE+RRTMGP is a set of codes for computing radiative fluxes in planetary atmospheres. RRTMGP uses a k-distribution to provide an optical description (absorption and possibly Rayleigh optical depth) of the gaseous atmosphere, along with the relevant source functions, on a pre-determined spectral grid given temperatures, pressures, and gas concentration. RTE computes fluxes given spectrally-resolved optical descriptions and source functions.</subtitle><entry><title type="html">v1.8 Release notes</title><link href="https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2023/11/27/v1.8-Release-notes.html" rel="alternate" type="text/html" title="v1.8 Release notes" /><published>2023-11-27T00:00:00+00:00</published><updated>2023-11-27T00:00:00+00:00</updated><id>https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2023/11/27/v1.8-Release-notes</id><content type="html" xml:base="https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2023/11/27/v1.8-Release-notes.html"><![CDATA[<p>Commit <a href="https://github.com/earth-system-radiation/rte-rrtmgp/commit/3ac0636b17d6a3f11e4085f91679393fceaa4e18">3ac0636</a>
to branch <code class="language-plaintext highlighter-rouge">main</code> makes the following changes:</p>

<ul>
<li>Libraries can be built in single precision by changes in <code class="language-plaintext highlighter-rouge">rte-kind/mo_rte_kind.F90</code>. Differences with respect to double precision are roughly 0.13 W/m2.</li>
<li>A class for computing the optical properties of aerosols following the MERRA representation has been added.</li>
<li>The repository is reorganized into <code class="language-plaintext highlighter-rouge">frontend</code> and <code class="language-plaintext highlighter-rouge">kernel</code> directories for <code class="language-plaintext highlighter-rouge">rte</code> and <code class="language-plaintext highlighter-rouge">rrtmgp</code>. Data has been moved to a separate [repository])((https://github.com/earth-system-radiation/rrtmgp-data/).</li>
<li>Citation information has been added.</li>
</ul>

<p>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.</p>]]></content><author><name></name></author><category term="Release-notes" /><summary type="html"><![CDATA[Commit 3ac0636 to branch main makes the following changes:]]></summary></entry><entry><title type="html">2022-06-02: Release notes</title><link href="https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2022/06/02/Release-notes.html" rel="alternate" type="text/html" title="2022-06-02: Release notes" /><published>2022-06-02T00:00:00+00:00</published><updated>2022-06-02T00:00:00+00:00</updated><id>https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2022/06/02/Release-notes</id><content type="html" xml:base="https://earth-system-radiation.github.io//rte-rrtmgp/release-notes/2022/06/02/Release-notes.html"><![CDATA[<p>Commit <a href="https://github.com/earth-system-radiation/rte-rrtmgp/commit/a4fe30cf4dab2e5fd8d3ab6f11683a82ae584475">a4fe30c</a>
to branch <code class="language-plaintext highlighter-rouge">main</code> makes the following changes:</p>

<ul>
Expand Down
31 changes: 9 additions & 22 deletions how-tos/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,33 +45,20 @@ <h1 class="post-title">How-to guides</h1>
<div class="post-content">
<h1 id="how-to-guides-will-live-here">How-to guides will live here</h1>

<h2 id="how-to-build-and-test-the-libraries-and-examples">How to: build and test the libraries and examples</h2>

<h3 id="building-and-testing-using-gnu-make">Building and testing using (Gnu) make</h3>
<h2 id="how-to-build-run-and-test-the-libraries-examples-and-unit-testing-codes">How-to: build, run, and test the libraries, examples, and unit-testing codes.</h2>

<ol>
<li>Set environment variables <code class="language-plaintext highlighter-rouge">FC</code> (the Fortran 2003 compiler) and <code class="language-plaintext highlighter-rouge">FCFLAGS</code> (compiler flags).
Examples are provided in the <code class="language-plaintext highlighter-rouge">Compiler-flags.md</code> file.</li>
<li>Set environment variable <code class="language-plaintext highlighter-rouge">RRTMGP_ROOT</code> to the top-level RTE+RRTMGP directory.
Set the variables <code class="language-plaintext highlighter-rouge">NCHOME</code> and <code class="language-plaintext highlighter-rouge">NFHOME</code> to the roots of the C and Fortran
netCDF installations. (Building the libraries alone )</li>
<li>Set environment variable <code class="language-plaintext highlighter-rouge">RTE_KERNELS</code> to <code class="language-plaintext highlighter-rouge">accel</code> if you want the OpenACC/OpenMP
kernels rather than the default.</li>
<li><code class="language-plaintext highlighter-rouge">make libs</code> in the top-level directory will make the RTE and RRTMGP libraries
and the regression tests in in <code class="language-plaintext highlighter-rouge">examples/</code> and <code class="language-plaintext highlighter-rouge">tests/</code>. Libraries and module
files are in <code class="language-plaintext highlighter-rouge">build/</code>; examples and tests are in the subdirectory containing
their source code.</li>
<li><code class="language-plaintext highlighter-rouge">make tests</code> runs the examples and regression tests.
(A few files need to be downloaded for <code class="language-plaintext highlighter-rouge">examples/rfmip-clear-sky</code>. The default
is to download with a Python script is shell script using <code class="language-plaintext highlighter-rouge">wget</code> is also available.)</li>
<li>Comparisons can be made with <code class="language-plaintext highlighter-rouge">make check</code> in the top level directory.
Evaluating the results of the tests requires <code class="language-plaintext highlighter-rouge">Python</code> and the packages
described in <code class="language-plaintext highlighter-rouge">environment.yml</code>. One approach is to use
<code class="language-plaintext highlighter-rouge">conda env create -f environment.yml; conda activate rte_rrtmgp_test; make check</code></li>
<li>Set environment variables <code class="language-plaintext highlighter-rouge">FC</code> (the Fortran 2003 compiler) and <code class="language-plaintext highlighter-rouge">FCFLAGS</code> (compiler flags). Examples are provided in the <code class="language-plaintext highlighter-rouge">Compiler-flags.md</code> file.</li>
<li>Set environment variables <code class="language-plaintext highlighter-rouge">RRTMGP_ROOT</code> to the top-level RTE+RRTMGP directory and <code class="language-plaintext highlighter-rouge">RTE_KERNELS</code> to <code class="language-plaintext highlighter-rouge">accel</code> if you want the OpenACC/OpenMP kernels rather than the default.</li>
<li><code class="language-plaintext highlighter-rouge">make libs</code> in the top-level directory will make the RTE and RRTMGP libraries.</li>
<li>The examples and testing codes use netCDF. Set the variables <code class="language-plaintext highlighter-rouge">NCHOME</code> and <code class="language-plaintext highlighter-rouge">NFHOME</code> to the roots of the C and Fortran netCDF installations.</li>
<li>Download the RRTMGP data either by cloning the <a href="https://github.com/earth-system-radiation/rrtmgp-data">data repository</a> or from the <a href="https://doi.org/10.5281/zenodo.7988260">Zenodo archive</a>. Set the environment variable <code class="language-plaintext highlighter-rouge">RRTMGP_DATA</code> to the root of this directory.</li>
<li><code class="language-plaintext highlighter-rouge">make tests</code> to will build and run the test.</li>
<li>Evaluating the results of the tests requires <code class="language-plaintext highlighter-rouge">Python</code> and the packages described in <code class="language-plaintext highlighter-rouge">environment.yml</code>. Comparisons can be made with <code class="language-plaintext highlighter-rouge">make check</code> in the top level directory.</li>
<li><code class="language-plaintext highlighter-rouge">make</code> invoked without a target in the top level attempts all three steps.</li>
</ol>

<h3 id="building-and-testing-using-gnu-make-1">Building and testing using (Gnu) make</h3>
<h3 id="building-and-testing-using-gnu-make">Building and testing using (Gnu) make</h3>

<p>Sergey Kosukhin and his colleagues at the Max Planck Institute for Meteorology
maintain the <code class="language-plaintext highlighter-rouge">autoconf</code> branch which adds Gnu <code class="language-plaintext highlighter-rouge">autotools</code> building to <code class="language-plaintext highlighter-rouge">main</code> branch.</p>
Expand Down
15 changes: 13 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@
<div class="home"><h1 class="page-heading">RTE+RRTMGP documentation</h1><p>This is the documentation for RTE+RRTMGP, a set of codes for computing radiative
fluxes in planetary atmospheres. RTE+RRTMGP is described in a
<a href="https://doi.org/10.1029/2019MS001621">paper</a> in
<a href="http://james.agu.org">Journal of Advances in Modeling Earth Systems</a>.</p>
<a href="http://james.agu.org">Journal of Advances in Modeling Earth Systems</a>.
The code itself can be sited as
doi:<a href="https://doi.org/10.5281/zenodo.3403172">10.5281/zenodo.3403172</a> or via the
DOI attached to each release.</p>

<p>RRTMGP uses a k-distribution to provide an optical description (absorption and
possibly Rayleigh optical depth) of the gaseous atmosphere, along with the
Expand All @@ -62,8 +65,16 @@ <h1 id="work-in-progress">Work in progress</h1>
<p>We are starting with the <a href="./reference/index.html">reference documentation</a>,
auto-generated from the code itself. This is provided separately for
RTE and RRTMGP and for the user-facing classes and underlying computational kernels.</p>

<p>We welcome contributions to the documentation via pull requests to the <code class="language-plaintext highlighter-rouge">documentation</code> branch
of the Github repository.</p>
<h2 class="post-list-heading">Posts</h2>
<ul class="post-list"><li><span class="post-meta">Jun 2, 2022</span>
<ul class="post-list"><li><span class="post-meta">Nov 27, 2023</span>
<h3>
<a class="post-link" href="/rte-rrtmgp/release-notes/2023/11/27/v1.8-Release-notes.html">
v1.8 Release notes
</a>
</h3></li><li><span class="post-meta">Jun 2, 2022</span>
<h3>
<a class="post-link" href="/rte-rrtmgp/release-notes/2022/06/02/Release-notes.html">
2022-06-02: Release notes
Expand Down
1 change: 1 addition & 0 deletions reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ <h1 id="referencetechnical-documentation">Reference/Technical documentation</h1>
and spectral quadrature point.</li>
<li>RTE and RRTMGP are agnostic to vertical ordering</li>
<li>Units are MKS</li>
<li>Procedures (with the exception of testing code) do not perform I/O</li>
</ul>

<h2 id="fortran-user-facing-class-interfaces">Fortran user-facing class interfaces</h2>
Expand Down
6 changes: 3 additions & 3 deletions reference/rrtmgp-fortran-interface/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ <h1>RRTMGP-Fortran</h1>
to represent the volume mixing ratios needed as input. Output suitable for
scattering emission, two-stream, or multi-stream calculations are provided
depending on which sub-class of RTE's
<a href="./rte-fortran-interface/module/mo_optical_props.html#type-ty_optical_props_arry">ty_optical_props_arry</a>
<a href="../rte-fortran-interface/module/mo_optical_props.html#type-ty_optical_props_arry">ty_optical_props_arry</a>
are provided. Planck source functions, if requested, are reported in a variable
of type <a href="./rte-fortran-interface/type/ty_source_func_lw.html">ty_source_func_lw.</a></p>
of type <a href="../rte-fortran-interface/type/ty_source_func_lw.html">ty_source_func_lw.</a></p>
<p>The listings below may not be exhaustive.
To see the full listings use the links at the top of the page.
There is a search bar in the top right.</p>
<p>Return to the <a href="../../index.html">Documentation overview</a> or the <a href="../../reference.html">reference overview</a>.</p>
<p>Return to the <a href="../../index.html">Documentation overview</a> or the [reference overview].</p>
</div>
<div class="col-md-4">
<div class="well">
Expand Down
20 changes: 10 additions & 10 deletions reference/rrtmgp-fortran-interface/lists/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,12 @@ <h1>Source Files</h1>
<g id="file~~graph~~FileGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<title>file~~graph~~FileGraph</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-112 218,-112 218,4 -4,4"/>
<!-- sourcefile~mo_gas_optics_rrtmgp.f90 -->
<!-- sourcefile~mo_cloud_optics_rrtmgp.f90 -->
<g id="file~~graph~~FileGraph_node1" class="node">
<title>sourcefile~mo_gas_optics_rrtmgp.f90</title>
<g id="a_file~~graph~~FileGraph_node1"><a xlink:href=".././sourcefile/mo_gas_optics_rrtmgp.f90.html" xlink:title="mo_gas_optics_rrtmgp.F90">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="184.5,-24 29.5,-24 29.5,0 184.5,0 184.5,-24"/>
<text text-anchor="middle" x="107" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">mo_gas_optics_rrtmgp.F90</text>
<title>sourcefile~mo_cloud_optics_rrtmgp.f90</title>
<g id="a_file~~graph~~FileGraph_node1"><a xlink:href=".././sourcefile/mo_cloud_optics_rrtmgp.f90.html" xlink:title="mo_cloud_optics_rrtmgp.F90">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="190,-24 24,-24 24,0 190,0 190,-24"/>
<text text-anchor="middle" x="107" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">mo_cloud_optics_rrtmgp.F90</text>
</a>
</g>
</g>
Expand All @@ -115,12 +115,12 @@ <h1>Source Files</h1>
</a>
</g>
</g>
<!-- sourcefile~mo_cloud_optics_rrtmgp.f90 -->
<!-- sourcefile~mo_gas_optics_rrtmgp.f90 -->
<g id="file~~graph~~FileGraph_node3" class="node">
<title>sourcefile~mo_cloud_optics_rrtmgp.f90</title>
<g id="a_file~~graph~~FileGraph_node3"><a xlink:href=".././sourcefile/mo_cloud_optics_rrtmgp.f90.html" xlink:title="mo_cloud_optics_rrtmgp.F90">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="190,-108 24,-108 24,-84 190,-84 190,-108"/>
<text text-anchor="middle" x="107" y="-93.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">mo_cloud_optics_rrtmgp.F90</text>
<title>sourcefile~mo_gas_optics_rrtmgp.f90</title>
<g id="a_file~~graph~~FileGraph_node3"><a xlink:href=".././sourcefile/mo_gas_optics_rrtmgp.f90.html" xlink:title="mo_gas_optics_rrtmgp.F90">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="184.5,-108 29.5,-108 29.5,-84 184.5,-84 184.5,-108"/>
<text text-anchor="middle" x="107" y="-93.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">mo_gas_optics_rrtmgp.F90</text>
</a>
</g>
</g>
Expand Down
Loading

0 comments on commit 4a4693a

Please sign in to comment.