Skip to content

Commit

Permalink
removing more references to trunk.
Browse files Browse the repository at this point in the history
  • Loading branch information
sit23 committed Sep 13, 2024
1 parent 0935e3c commit d386e1f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/source/modules/socrates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Summary
SOCRATES (Suite Of Community RAdiative Transfer codes based on Edwards and Slingo) is the radiation scheme used by UK Met Office for Earth and planetary science [MannersEtAl2015]_, which has many significant advantages over RRTM, notably its flexibility in terms of atmospheric composition and the spectral properties of the radiation scheme (e.g. number of bands, etc).

* The code used to integrate Socrates into Isca is contained within the folder ``src/atmos_params/socrates/interface``.
* The Socrates source code itself is **NOT** packed within this Isca repository, and **NEW** users will need to download it from the `Met Office Science Repository <https://code.metoffice.gov.uk/trac/socrates>`_. Users can then either choose to put the Socrates code within the directory ``src/atmos_params/socrates/src/trunk``, or can set the bash environment variable ``GFDL_SOC`` equal to the location of the source code for Socrates. Detailed instructions on how to do this are included in the `README.md <https://github.com/ExeClim/Isca/blob/master/exp/test_cases/socrates_test/README.md>`_ for the Socrates test-case: ``exp/test_cases/socrates_test/README.md``.
* The Socrates source code itself is **NOT** packed within this Isca repository, and **NEW** users will need to download it from the `Met Office Science Repository <https://code.metoffice.gov.uk/trac/socrates>`_. Users can then either choose to put the Socrates code within the directory ``src/atmos_params/socrates/src/1703``, or can set the bash environment variable ``GFDL_SOC`` equal to the location of the source code for Socrates. Detailed instructions on how to do this are included in the `README.md <https://github.com/ExeClim/Isca/blob/master/exp/test_cases/socrates_test/README.md>`_ for the Socrates test-case: ``exp/test_cases/socrates_test/README.md``.
* Some users of Isca may wish to compile Isca separately with several different versions of Socrates (If you only want a single version then you can ignore this). To do this, you will need to create a folder containing all of your Socrates versions and set the ``GFDL_SOC_DIR`` environment variable to that location. Within the ``GFDL_SOC_DIR`` folder should be folders containing each of your Socrates versions. Then when you create the ``SocratesCodeBase`` object in your experiment script, you can use the option ``socrates_version=YOUR_VERSIONS_FOLDER_NAME_HERE``. For example, if my ``GFDL_SOC_DIR`` folder has folders within it called ``1703`` and ``2207``, which are my different versions, then I can choose version ``1703`` by setting ``socrates_version=1703`` when I create a ``SocratesCodeBase`` object in my experiment script. Then, when Isca compiles, it will build seperate executables for the different Socrates versions.
* The basis of ``socrates_interface`` was coded by Mark Hammond (Univ. of Oxford) and James Manners (Met Office) and modified by Stephen Thomson (Univ. of Exeter) [Thomson_and_Vallis2019]_. Features added include seasonality in the radiation based on Isca's ``astronomy`` package, and the ability to use a ``radiation timestep != atmospheric timestep``.
* Socrates radiation scheme requires ``mass mixing ratios`` for all quantities (e.g. CO2, water vapor etc). This contrasts with RRTM, which wants ``volume mixing ratios``.
Expand Down Expand Up @@ -66,10 +66,10 @@ The following namelist variables set radiation time stepping and spatial samplin
Spectral files
^^^^^^^^^^^^^^

Socrates reads external input spectral files that tell it the number of spectral bands to use, with one file setting the shortwave options, and another file setting the longwave options. Some spectral files have lots of bands, which will make the model run slowly. The default files used in the Met Office's Unified Model-GA7, and also in Isca, can be found within the ``data/spectra`` directory of Socrates source code. For example, it can be here if you put the Socrates source code within the ``trunk`` directory:
Socrates reads external input spectral files that tell it the number of spectral bands to use, with one file setting the shortwave options, and another file setting the longwave options. Some spectral files have lots of bands, which will make the model run slowly. The default files used in the Met Office's Unified Model-GA7, and also in Isca, can be found within the ``data/spectra`` directory of Socrates source code. For example, it can be here if you put the Socrates source code within the ``1703`` directory:
::
src/atmos_param/socrates/src/trunk/data/spectra/ga7/sp_lw_ga7 for the longwave
src/atmos_param/socrates/src/trunk/data/spectra/ga7/sp_sw_ga7 for the shortwave
src/atmos_param/socrates/src/1703/data/spectra/ga7/sp_lw_ga7 for the longwave
src/atmos_param/socrates/src/1703/data/spectra/ga7/sp_sw_ga7 for the shortwave

or here if you have set ``GFDL_SOC`` as an environment variable:
::
Expand Down

0 comments on commit d386e1f

Please sign in to comment.