edit homepage and ref

CliMA · May 23, 2022 · 5fbe9cf · 5fbe9cf
1 parent a4e6e80
commit 5fbe9cf
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/docs/src/References.md b/docs/src/References.md
@@ -3,3 +3,10 @@
 ```@bibliography
 ```
 
+Cohen, Y., Lopez-Gomez, I., Jaruga A., He, J., Kaul, C. M., Schneider, T., 2020: **Unified entrainment and detrainment closures for extended eddy-diffusivity mass-flux schemes**. Journal of Advances in Modeling Earth Systems, 12, e2020MS002162. https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2020MS002162.
+
+Lopez-Gomez, I., Cohen, Y., He, J., Jaruga, A., Schneider, T., 2020: **A generalized mixing length closure for eddy-diﬀusivity mass-flux schemes of turbulence and convection**. Journal of Advances in Modeling Earth Systems, 12, e2020MS002161. https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2020MS002161.
+
+Shen, Z., Sridhar, A., Tan, Z., Jaruga, A., & Schneider, T. (2022). **A library of large-eddy simulations forced by global climate models**. Journal of Advances in Modeling Earth Systems, 14, e2021MS002631 https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021MS002631.
+
+Tan, Z., Kaul, C. M., Pressel, K. G., Cohen, Y., Schneider, T., Teixeira, J., 2018: **An extended eddy-diffusivity mass-flux scheme for unified representation of subgrid-scale turbulence and convection**. Journal of Advances in Modeling Earth Systems, 10, 770-800. https://doi.org/10.1002/2017MS001162.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,2 +1,25 @@
 # TurbulenceConvection.jl
 
+# CalibrateEDMF.jl
+
+```@meta
+CurrentModule = TurbulenceConvection
+```
+
+TurbulenceConvection.jl (TC.jl) is a julia implemntation of the Extendend Eddy-Diffusivity Mass-Flux (EDMF) model published in Tan et al. (2018); Cohen et al. (2020) and Lopez-Gomez et al. (2020). The package conatains a Single Column Model (SCM) which solvers for a single column of a climate model with vertical fluxes computed by the dynamics of the EDMF's 'updrafts' and 'environment' subdomains. 
+The preformance of TC.jl is routinly monitored by a Continuous Integration (CI) and plots of model varianbes from a range of simualtions are plotted in Buildkites. These plots can be viewed via the colored check (`✓`, `x` or `⦿`) near the commit tag in the 'code' page on github web interface.
+
+The Extended EDMF model can be run with several specifications such as:
+ - Case: what model setup is run. typically corresponding to an observation campaign (i.e. DYCOMS_RF01 for a standard stratocumulus case) or an LES driven simualtion of the SCM based on CliMA's LES library (Shen et al.  2022).
+- Closure types: such as entrainment, mixing length etc. 
+- Model specifications: such as forcing properties, domian and grid etc.
+- Parameters: Such as the physical parmaeters listed in Table 2 in Cohen et al. (2020) and Table 1 in Lopez-Gomez et al. (2020); as well as parameters relating to machine learning models (Fourier Neural Operators, Neural Networks etc.) 
+
+The package depndends on the following clima packages: [ClimaCore.jl](https://github.com/CliMA/ClimaCore.jl), [Thermodyanmics.jl](https://github.com/CliMA/Thermodynamics.jl), [SurfaceFlux.jl](https://github.com/CliMA/SurfaceFluxes.jl), [OperatorFlux.jl](https://github.com/CliMA/OperatorFlux.jl)
+
+
+
+
+## Authors
+
+CalibrateEDMF.jl is being developed by the [Climate Modeling Alliance](https://clima.caltech.edu). The main developers are Charles Kawczynski, Yair Cohen, Anna Jaruga, Ignacio Lopez-Gomez, Haakon Ludvig Langeland Ervik, Costa Christopoulos.