.. _hco:

##########################################
The Harmonized Emissions Component (HEMCO)
##########################################

.. raw:: html

   <p>
   <a href="https://github.com/geoschem/HEMCO/releases"><img src="https://img.shields.io/github/v/release/geoschem/HEMCO?include_prereleases&label=Latest%20Pre-Release"></a>
   <a href="https://github.com/geoschem/HEMCO/releases"><img src="https://img.shields.io/github/v/release/geoschem/HEMCO?label=Latest%20Stable%20Release"></a>
   <a href="https://github.com/geoschem/HEMCO/releases/"><img src="https://img.shields.io/github/release-date/geoschem/HEMCO"></a>
   <a href="https://github.com/geoschem/HEMCO/blob/main/LICENSE.txt"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
   <a href="https://doi.org/10.5281/zenodo.4618253"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4618253.svg"></a>
   <a href="https://hemco.readthedocs.io/en/latest/"><img src="https://img.shields.io/readthedocs/hemco?label=ReadTheDocs"></a>
   <a href="https://dev.azure.com/geoschem/HEMCO/_build?definitionId=11"><img src="https://dev.azure.com/geoschem/hemco/_apis/build/status/Quick%20Build?branchName=dev"></a>
   </p>

The **Harmonized Emissions Component (HEMCO)** is a software component
for computing atmospheric emissions from different sources, regions,
and species on a user-defined grid. It can combine, overlay, and
update a set of data inventories :ref:`base emissions <hco-cfg-base>`
and :ref:`scale factors <hco-cfg-scalefac>`, as specified by the user
through :ref:`the HEMCO configuration file <hco-cfg>`. Emissions that
depend on environmental variables and non-linear parameterizations are
calculated in separate :ref:`hco-ext`. HEMCO can be run in
:ref:`standalone mode <hco-sa-guide>` or :ref:`coupled to an
atmospheric model <hemco-coupling>`.  A more detailed description of
HEMCO is given in :cite:t:`Keller_et_al._2014` and
:cite:t:`Lin_et_al._2021`. 

.. toctree::
   :maxdepth: 2
   :caption: HEMCO Standalone User Guide

   hco-sa-guide/intro.rst
   hco-sa-guide/hardware.rst
   hco-sa-guide/software.rst
   hco-sa-guide/login-env.rst
   hco-sa-guide/download-code.rst
   hco-sa-guide/create-rundir.rst
   hco-sa-guide/compiling.rst
   hco-sa-guide/config-sim.rst
   hco-sa-guide/download-data.rst
   hco-sa-guide/run-standalone.rst

.. toctree::
   :maxdepth: 2
   :caption: HEMCO Reference Guide

   hco-ref-guide/intro.rst
   hco-ref-guide/basic-examples.rst
   hco-ref-guide/hemco-config.rst
   hco-ref-guide/extensions.rst
   hco-ref-guide/units.rst
   hco-ref-guide/diagnostics.rst
   hco-ref-guide/more-examples.rst
   hco-ref-guide/under-the-hood.rst
   hco-ref-guide/input-file-format.rst
   coupling/intro.rst
   hco-ref-guide/known-bugs.rst
   hco-ref-guide/version-history.rst
   hco-ref-guide/key-references.rst

.. toctree::
   :maxdepth: 1
   :caption: Supplemental Guides

   geos-chem-shared-docs/supplemental-guides/load-libraries-guide.rst
   geos-chem-shared-docs/supplemental-guides/spack-guide.rst
   geos-chem-shared-docs/supplemental-guides/error-guide.rst
   geos-chem-shared-docs/supplemental-guides/debug-guide.rst
   geos-chem-shared-docs/doc/gcid-portal-overview.rst
   geos-chem-shared-docs/supplemental-guides/bashdatacatalog.rst
   geos-chem-shared-docs/supplemental-guides/parallel-guide.rst
   geos-chem-shared-docs/supplemental-guides/netcdf-guide.rst
   geos-chem-shared-docs/supplemental-guides/coards-guide.rst
   geos-chem-shared-docs/supplemental-guides/related-docs.rst

.. toctree::
   :maxdepth: 1
   :caption: Help and Reference

   reference/CONTRIBUTING.md
   reference/SUPPORT.md
   geos-chem-shared-docs/editing_these_docs.rst