Merge pull request #7 from chrisroadmap/twolayer

Add two-layer climate model

Author: chrisroadmap

README.rst

@@ -1,7 +1,7 @@
 Climate forcing
 ===============
 
-Some tools that I use in analysis of climate models.
+An incomplete toolbox of scripts and modules used for analysis of climate models and climate data. 
 
 Installation
 ============
@@ -32,13 +32,23 @@ aprp: Approximate Partial Radiative Perturbation
 ------------------------------------------------
 Generates the components of shortwave effective radiative forcing (ERF) from changes in absorption, scattering and cloud amount. For aerosols, this can be used to approximate the ERF from aerosol-radiation interactions (ERFari) and aerosol-cloud interactions (ERFaci). Citations:
 
-- Zelinka, M. D., Andrews, T., Forster, P. M., and Taylor, K. E. (2014), Quantifying components of aerosol‐cloud‐radiation interactions in climate models, J. Geophys. Res. Atmos., 119, 7599– 7615, https://doi.org/10.1002/2014JD021710.
-- Taylor, K. E., Crucifix, M., Braconnot, P., Hewitt, C. D., Doutriaux, C., Broccoli, A. J., Mitchell, J. F. B., & Webb, M. J. (2007). Estimating Shortwave Radiative Forcing and Response in Climate Models, Journal of Climate, 20(11), 2530-2543, https://doi.org/10.1175/JCLI4143.1
+- Zelinka, M. D., Andrews, T., Forster, P. M., and Taylor, K. E. (2014), Quantifying components of aerosol‐cloud‐radiation interactions in climate models, J. Geophys. Res. Atmos., 119, 7599–7615, https://doi.org/10.1002/2014JD021710.
+- Taylor, K. E., Crucifix, M., Braconnot, P., Hewitt, C. D., Doutriaux, C., Broccoli, A. J., Mitchell, J. F. B., & Webb, M. J. (2007). Estimating Shortwave Radiative Forcing and Response in Climate Models, Journal of Climate, 20(11), 2530–2543, https://doi.org/10.1175/JCLI4143.1
 
 atmos: general atmospheric physics tools
 ----------------------------------------
 humidity: Conversions for specific to relative humidity and vice versa. 
 
+twolayermodel: two-layer energy balance climate model
+-----------------------------------------------------
+Implementation of the Held et al (2010) and Geoffroy et al (2013a, 2013b) two-layer climate model. Thanks to `Glen Harris <https://www.metoffice.gov.uk/research/people/glen-harris/>`_ for the original code.
+
+- Held, I. M., Winton, M., Takahashi, K., Delworth, T., Zeng, F., & Vallis, G. K. (2010), Probing the Fast and Slow Components of Global Warming by Returning Abruptly to Preindustrial Forcing, J. Climate, 23(9), 2418–2427, https://doi.org/10.1175/2009JCLI3466.1
+- Geoffroy, O., Saint-Martin, D., Olivié, D. J. L., Voldoire, A., Bellon, G., & Tytéca, S. (2013a). Transient Climate Response in a Two-Layer Energy-Balance Model. Part I: Analytical Solution and Parameter Calibration Using CMIP5 AOGCM Experiments, J. Climate, 26(6), 1841-1857, https://doi.org/10.1175/JCLI-D-12-00195.1
+- Geoffroy, O., Saint-Martin, D., Bellon, G., Voldoire, A., Olivié, D. J. L., & Tytéca, S. (2013b), Transient Climate Response in a Two-Layer Energy-Balance Model. Part II: Representation of the Efficacy of Deep-Ocean Heat Uptake and Validation for CMIP5 AOGCMs, J. Climate, 26(6), 1859-1876, https://doi.org/10.1175/JCLI-D-12-00196.1
+- Palmer, M. D., Harris, G. R. and Gregory, J. M. (2018), Extending CMIP5 projections of global mean temperature change and sea level rise due to the thermal expansion using a physically-based emulator, Environ. Res. Lett., 13(8), 084003, https://doi.org/10.1088/1748-9326/aad2e4
+
+
 utci: Universal Climate Thermal Index
 -------------------------------------
 Calculates a measure of heat stress based on meteorological data. The code provided is a Python translation of the original FORTRAN, used under kind permission of Peter Bröde. If you use this code please cite:

setup.py

@@ -18,7 +18,9 @@
 
 REQUIREMENTS = [
     "numpy",
-    "netCDF4"
+    "netCDF4",
+    "pandas",
+    "scipy"
 ]
 REQUIREMENTS_TESTS = [
     "codecov",

src/climateforcing/constants.py

@@ -1 +1,3 @@
+EARTHRADIUS = 6371000  # m
+SECPERYEAR = 60 * 60 * 24 * 365  # s   # should be 365.2425
 STEFAN_BOLTZMANN = 5.670374419e-8  # W m-2 K-4