API reference
=============

fair.fair
---------

.. automodule:: fair

.. autoclass:: fair.FAIR
  :members:

fair.energy_balance_model
-------------------------

.. automodule:: fair.energy_balance_model
  :members:

fair.interface
--------------

.. automodule:: fair.interface
  :members:

fair.io
-------

.. automodule:: fair.io
  :members:

fair.constants
--------------

.. automodule:: fair.constants
.. autodata:: fair.constants.DOUBLING_TIME_1PCT
.. autodata:: fair.constants.TIME_AXIS
.. autodata:: fair.constants.SCENARIO_AXIS
.. autodata:: fair.constants.CONFIG_AXIS
.. autodata:: fair.constants.SPECIES_AXIS
.. autodata:: fair.constants.GASBOX_AXIS

fair.earth_params
-----------------

.. automodule:: fair.earth_params
.. autodata:: fair.earth_params.molecular_weight_air
.. autodata:: fair.earth_params.earth_radius
.. autodata:: fair.earth_params.mass_atmosphere
.. autodata:: fair.earth_params.seconds_per_year

fair.forcing
------------

.. automodule:: fair.forcing

fair.forcing.ghg
~~~~~~~~~~~~~~~~

.. automodule:: fair.forcing.ghg
   :members:

fair.forcing.minor
~~~~~~~~~~~~~~~~~~

.. automodule:: fair.forcing.minor
   :members:

fair.forcing.ozone
~~~~~~~~~~~~~~~~~~

.. automodule:: fair.forcing.ozone
   :members:

fair.forcing.aerosol
~~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.forcing.aerosol

fair.forcing.aerosol.erfari
+++++++++++++++++++++++++++

.. automodule:: fair.forcing.aerosol.erfari
   :members:

fair.forcing.aerosol.erfaci
+++++++++++++++++++++++++++

.. automodule:: fair.forcing.aerosol.erfaci
   :members:

fair.gas_cycle
--------------

.. automodule:: fair.gas_cycle

fair.gas_cycle.ch4_lifetime
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.gas_cycle.ch4_lifetime
   :members:

fair.gas_cycle.eesc
~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.gas_cycle.eesc
   :members:

fair.gas_cycle.forward
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.gas_cycle.forward
   :members:

fair.gas_cycle.inverse
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.gas_cycle.inverse
   :members:

fair.structure
--------------

.. automodule:: fair.structure

fair.structure.species
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.structure.species
   :members:

fair.structure.units
~~~~~~~~~~~~~~~~~~~~

.. automodule:: fair.structure.units
   :members: