.. EMC² documentation master file, created by
   sphinx-quickstart on Thu Oct 17 09:39:03 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to EMC²'s documentation!
=================================

The Earth Model Column Collaboratory (EMC²) is an open-source framework for
atmospheric model evaluation against observational data and model
intercomparisons. This framework is specifically designed to simulate the
Atmospheric Radiation Measurement (ARM) User Facility remote-sensing
measurements while being faithful to the representation of physical processes
in leading state-of-the-art models such as the Energy Exascale Earth System
Model (E3SM).
Detailed description of EMC² is provided in Silber et al. (GMD, 2022;
https://doi.org/10.5194/gmd-15-901-2022).

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   usage/index.rst
   EMC2example.ipynb
   contributing
   API/index.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Citing EMC²
===========

If the Earth Model Column Collaboratory (EMC²) is used in your manuscript,
please cite:

    Silber, I., Jackson, R. C., Fridlind, A. M., Ackerman, A. S., Collis, S.,
    Verlinde, J., and Ding, J.: The Earth Model Column Collaboratory (EMC2)
    v1.1: an open-source ground-based lidar and radar instrument simulator and
    subcolumn generator for large-scale models, Geosci. Model Dev., 15,
    901–927, https://doi.org/10.5194/gmd-15-901-2022, 2022.


EMC² Tutorial
=============

A tutorial for EMC² processing (in this case using E3SM model output) can
be found on the `ARM-Notebooks GitHub repository <https://github.com/ARM-Development/ARM-Notebooks/blob/main/Tutorials/Open-Science-Workshop-2022/tutorials/EMC2_demo_w_E3SM.ipynb>`_