How-to guides will live here

-

How to: build and test the libraries and examples

- -

Building and testing using (Gnu) make

+

How-to: build, run, and test the libraries, examples, and unit-testing codes.

    -
  1. Set environment variables FC (the Fortran 2003 compiler) and FCFLAGS (compiler flags). -Examples are provided in the Compiler-flags.md file.
    2. -
  2. Set environment variable RRTMGP_ROOT to the top-level RTE+RRTMGP directory. -Set the variables NCHOME and NFHOME to the roots of the C and Fortran -netCDF installations. (Building the libraries alone )
    3. -
  3. Set environment variable RTE_KERNELS to accel if you want the OpenACC/OpenMP -kernels rather than the default.
    4. -
  4. make libs in the top-level directory will make the RTE and RRTMGP libraries -and the regression tests in in examples/ and tests/. Libraries and module -files are in build/; examples and tests are in the subdirectory containing -their source code.
    5. -
  5. make tests runs the examples and regression tests. -(A few files need to be downloaded for examples/rfmip-clear-sky. The default -is to download with a Python script is shell script using wget is also available.)
    6. -
  6. Comparisons can be made with make check in the top level directory. -Evaluating the results of the tests requires Python and the packages -described in environment.yml. One approach is to use -conda env create -f environment.yml; conda activate rte_rrtmgp_test; make check
    7. +
  7. Set environment variables FC (the Fortran 2003 compiler) and FCFLAGS (compiler flags). Examples are provided in the Compiler-flags.md file.
    8. +
  8. Set environment variables RRTMGP_ROOT to the top-level RTE+RRTMGP directory and RTE_KERNELS to accel if you want the OpenACC/OpenMP kernels rather than the default.
    9. +
  9. make libs in the top-level directory will make the RTE and RRTMGP libraries.
    10. +
  10. The examples and testing codes use netCDF. Set the variables NCHOME and NFHOME to the roots of the C and Fortran netCDF installations.
    11. +
  11. Download the RRTMGP data either by cloning the data repository or from the Zenodo archive. Set the environment variable RRTMGP_DATA to the root of this directory.
    12. +
  12. make tests to will build and run the test.
    13. +
  13. Evaluating the results of the tests requires Python and the packages described in environment.yml. Comparisons can be made with make check in the top level directory.
  14. make invoked without a target in the top level attempts all three steps.
-

Building and testing using (Gnu) make

+

Building and testing using (Gnu) make

Sergey Kosukhin and his colleagues at the Max Planck Institute for Meteorology maintain the autoconf branch which adds Gnu autotools building to main branch.

diff --git a/index.html b/index.html index 6334288b6..ae6eda14c 100644 --- a/index.html +++ b/index.html @@ -39,7 +39,10 @@

RTE+RRTMGP documentation

This is the documentation for RTE+RRTMGP, a set of codes for computing radiative fluxes in planetary atmospheres. RTE+RRTMGP is described in a paper in -Journal of Advances in Modeling Earth Systems.

+Journal of Advances in Modeling Earth Systems. +The code itself can be sited as +doi:10.5281/zenodo.3403172 or via the +DOI attached to each release.

RRTMGP uses a k-distribution to provide an optical description (absorption and possibly Rayleigh optical depth) of the gaseous atmosphere, along with the @@ -62,8 +65,16 @@

Work in progress

We are starting with the reference documentation, auto-generated from the code itself. This is provided separately for RTE and RRTMGP and for the user-facing classes and underlying computational kernels.

+ +

We welcome contributions to the documentation via pull requests to the documentation branch +of the Github repository.

Posts

-
diff --git a/reference/rrtmgp-fortran-interface/lists/files.html b/reference/rrtmgp-fortran-interface/lists/files.html index 542970385..cec1cbac3 100644 --- a/reference/rrtmgp-fortran-interface/lists/files.html +++ b/reference/rrtmgp-fortran-interface/lists/files.html @@ -97,12 +97,12 @@

Source Files

file~~graph~~FileGraph - + -sourcefile~mo_gas_optics_rrtmgp.f90 - - -mo_gas_optics_rrtmgp.F90 +sourcefile~mo_cloud_optics_rrtmgp.f90 + + +mo_cloud_optics_rrtmgp.F90 @@ -115,12 +115,12 @@

Source Files

 - + -sourcefile~mo_cloud_optics_rrtmgp.f90 - - -mo_cloud_optics_rrtmgp.F90 +sourcefile~mo_gas_optics_rrtmgp.f90 + + +mo_gas_optics_rrtmgp.F90 diff --git a/reference/rrtmgp-fortran-interface/lists/modules.html b/reference/rrtmgp-fortran-interface/lists/modules.html index 6d62bc364..7dce4ebf9 100644 --- a/reference/rrtmgp-fortran-interface/lists/modules.html +++ b/reference/rrtmgp-fortran-interface/lists/modules.html @@ -99,37 +99,37 @@

Modules

module~~graph~~ModuleGraph - + -module~mo_cloud_optics_rrtmgp - - -mo_cloud_optics_rrtmgp +module~mo_aerosol_optics_rrtmgp_merra + + +mo_aerosol_optics_rrtmgp_merra - + -mo_rte_kind - -mo_rte_kind +mo_rte_util_array_validation + +mo_rte_util_array_validation - + -module~mo_cloud_optics_rrtmgp->mo_rte_kind - - +module~mo_aerosol_optics_rrtmgp_merra->mo_rte_util_array_validation + + - + mo_rte_config mo_rte_config - + -module~mo_cloud_optics_rrtmgp->mo_rte_config - +module~mo_aerosol_optics_rrtmgp_merra->mo_rte_config + @@ -138,174 +138,174 @@

Modules

mo_optical_props - + -module~mo_cloud_optics_rrtmgp->mo_optical_props +module~mo_aerosol_optics_rrtmgp_merra->mo_optical_props - + -mo_rte_util_array_validation - -mo_rte_util_array_validation +mo_rte_kind + +mo_rte_kind - + +module~mo_aerosol_optics_rrtmgp_merra->mo_rte_kind + + + + + +module~mo_cloud_optics_rrtmgp + + +mo_cloud_optics_rrtmgp + + + + + module~mo_cloud_optics_rrtmgp->mo_rte_util_array_validation - - + + + + + +module~mo_cloud_optics_rrtmgp->mo_rte_config + + + + + +module~mo_cloud_optics_rrtmgp->mo_optical_props + + + + + +module~mo_cloud_optics_rrtmgp->mo_rte_kind + + - + module~mo_gas_optics_rrtmgp - + mo_gas_optics_rrtmgp - + + +module~mo_gas_optics_rrtmgp->mo_rte_util_array_validation + + + + + +mo_gas_concentrations + +mo_gas_concentrations + + -module~mo_gas_optics_rrtmgp->mo_rte_kind - - +module~mo_gas_optics_rrtmgp->mo_gas_concentrations + + - + module~mo_gas_optics_rrtmgp->mo_rte_config - + mo_gas_optics - -mo_gas_optics + +mo_gas_optics - + module~mo_gas_optics_rrtmgp->mo_gas_optics - - - - - -mo_gas_optics_constants - -mo_gas_optics_constants + + - - -module~mo_gas_optics_rrtmgp->mo_gas_optics_constants - - - - + -mo_rte_util_array - -mo_rte_util_array +mo_gas_optics_util_string + +mo_gas_optics_util_string - - -module~mo_gas_optics_rrtmgp->mo_rte_util_array - - + + +module~mo_gas_optics_rrtmgp->mo_gas_optics_util_string + + - + -mo_gas_optics_rrtmgp_kernels - -mo_gas_optics_rrtmgp_kernels +mo_source_functions + +mo_source_functions - - -module~mo_gas_optics_rrtmgp->mo_gas_optics_rrtmgp_kernels - - + + +module~mo_gas_optics_rrtmgp->mo_source_functions + + - + module~mo_gas_optics_rrtmgp->mo_optical_props - - -module~mo_gas_optics_rrtmgp->mo_rte_util_array_validation - - + + +module~mo_gas_optics_rrtmgp->mo_rte_kind + + - + -mo_source_functions - -mo_source_functions +mo_gas_optics_constants + +mo_gas_optics_constants - - -module~mo_gas_optics_rrtmgp->mo_source_functions - - + + +module~mo_gas_optics_rrtmgp->mo_gas_optics_constants + + - + -mo_gas_optics_util_string - -mo_gas_optics_util_string +mo_rte_util_array + +mo_rte_util_array - - -module~mo_gas_optics_rrtmgp->mo_gas_optics_util_string - - + + +module~mo_gas_optics_rrtmgp->mo_rte_util_array + + - + -mo_gas_concentrations - -mo_gas_concentrations +mo_gas_optics_rrtmgp_kernels + +mo_gas_optics_rrtmgp_kernels - - -module~mo_gas_optics_rrtmgp->mo_gas_concentrations + + +module~mo_gas_optics_rrtmgp->mo_gas_optics_rrtmgp_kernels - - -module~mo_aerosol_optics_rrtmgp_merra - - -mo_aerosol_optics_rrtmgp_merra - - - - - -module~mo_aerosol_optics_rrtmgp_merra->mo_rte_kind - - - - - -module~mo_aerosol_optics_rrtmgp_merra->mo_rte_config - - - - - -module~mo_aerosol_optics_rrtmgp_merra->mo_optical_props - - - - - -module~mo_aerosol_optics_rrtmgp_merra->mo_rte_util_array_validation - - -