api.rst

API Reference

This page provides an auto-generated summary of esmlab’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

.. currentmodule:: esmlab

Utilities

.. autosummary::
   datasets.open_dataset

Configuration

.. autosummary::
   config.get
   config.set

Statistics functions

.. autosummary::
   statistics.mae
   statistics.mse
   statistics.rmse
   statistics.weighted_sum
   statistics.weighted_mean
   statistics.weighted_std
   statistics.weighted_rmsd
   statistics.weighted_cov
   statistics.weighted_corr

Climatologies

.. autosummary::
   core.climatology

Anomalies

.. autosummary::
   core.anomaly

Resample

.. autosummary::
   core.resample

.. currentmodule:: esmlab.datasets

.. autofunction:: open_dataset

.. currentmodule:: esmlab.config

.. autofunction:: get

.. autofunction:: set

.. autofunction:: collect

.. autofunction:: refresh

.. currentmodule:: esmlab.statistics

.. autofunction:: mae

.. autofunction:: mse

.. autofunction:: rmse

.. autofunction:: weighted_sum

.. autofunction:: weighted_mean

.. autofunction:: weighted_std

.. autofunction:: weighted_rmsd

.. autofunction:: weighted_cov

.. autofunction:: weighted_corr

.. currentmodule:: esmlab.core

.. autofunction:: climatology

.. autofunction:: anomaly

.. autofunction:: resample