api.rst

API

The API of the statistical downscaling and bias adjustment module (sdba) is documented :ref:`on this page <SDBA's user API>`. The API of the cfchecks, datachecks, missing and dataflags modules are in :ref:`Health checks`. Finally, the API of the translating tools is on the :ref:`Internationalization` page.

Indicators

.. toctree::

  indicators_api

Indices

.. toctree::

   indices

Ensembles module

.. automodule:: xclim.ensembles
   :members: create_ensemble, ensemble_mean_std_max_min, ensemble_percentiles

.. automodule:: xclim.ensembles._reduce

.. autofunction:: xclim.ensembles.kkz_reduce_ensemble

.. autofunction:: xclim.ensembles.kmeans_reduce_ensemble

.. autofunction:: xclim.ensembles.plot_rsqprofile

.. automodule:: xclim.ensembles._robustness

.. autofunction:: xclim.ensembles.change_significance

.. autofunction:: xclim.ensembles.robustness_coefficient

Indicator tools

.. automodule:: xclim.core.indicator
   :members:
   :member-order: bysource
   :show-inheritance:

Unit handling module

.. automodule:: xclim.core.units
   :members:
   :undoc-members:
   :show-inheritance:

Other utilities

.. automodule:: xclim.core.calendar
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: xclim.core.formatting
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: xclim.core.options
   :members: set_options

.. automodule:: xclim.core.utils
   :members:
   :undoc-members:
   :member-order: bysource
   :show-inheritance:

Other xclim modules

Spatial Analogs module

See :ref:`Spatial analogues`.

Testing module

.. automodule:: xclim.testing
    :members:

Subset module

Warning

Subsetting is now offered via clisops.core.subset. The subsetting functions offered by clisops are available at the following link:

:doc:`CLISOPS API <clisops:api>`

Note

For more information about clisops refer to their documentation here: :doc:`CLISOPS documentation <clisops:readme>`