Skip to content

Latest commit

 

History

History
142 lines (101 loc) · 2.86 KB

api.rst

File metadata and controls

142 lines (101 loc) · 2.86 KB

API Reference

This page provides an auto-generated summary of xarray-simlab's API. For more details and examples, refer to the relevant sections in the main part of the documentation.

Top-level functions

.. currentmodule:: xsimlab

.. autosummary::
   :toctree: _api_generated/

   create_setup

Dataset.xsimlab (xarray accessor)

This accessor extends :py:class:`xarray.Dataset` with all the methods and properties listed below. Proper use of this accessor should be like:

>>> import xarray as xr         # first import xarray
>>> import xsimlab              # import xsimlab (the 'xsimlab' accessor is registered)
>>> ds = xr.Dataset()           # create or load an xarray Dataset
>>> ds.xsimlab.<meth_or_prop>   # access to the methods and properties listed below
.. currentmodule:: xarray

Properties

.. autosummary::
   :toctree: _api_generated/
   :template: autosummary/accessor_attribute.rst

   Dataset.xsimlab.clock_coords
   Dataset.xsimlab.master_clock_dim
   Dataset.xsimlab.output_vars

Methods

.. autosummary::
   :toctree: _api_generated/
   :template: autosummary/accessor_method.rst

   Dataset.xsimlab.update_clocks
   Dataset.xsimlab.update_vars
   Dataset.xsimlab.filter_vars
   Dataset.xsimlab.run

Model

Creating a model

.. currentmodule:: xsimlab

.. autosummary::
   :toctree: _api_generated/

   Model

Creating a new model from an existing one

.. autosummary::
   :toctree: _api_generated/

   Model.clone
   Model.update_processes
   Model.drop_processes

Model introspection

Model implements an immutable mapping interface where keys are process names and values are objects of Process subclasses (attribute-style access is also supported).

.. autosummary::
   :toctree: _api_generated/

   Model.all_vars
   Model.all_vars_dict
   Model.input_vars
   Model.input_vars_dict
   Model.dependent_processes
   Model.visualize

Running a model

In most cases, the methods listed below should not be used directly. For running simulations, it is preferable to use the Dataset.xsimlab accessor instead. These methods might be useful though, e.g., for debugging or for using Model objects with other interfaces.

.. autosummary::
   :toctree: _api_generated/

   Model.initialize
   Model.run_step
   Model.finalize_step
   Model.finalize

Process

Creating a process

.. autosummary::
   :toctree: _api_generated/

   process

Process introspection and variables

.. autosummary::
   :toctree: _api_generated/

   process_info
   variable_info
   filter_variables

Variable

.. autosummary::
   :toctree: _api_generated/

   variable
   foreign
   group
   on_demand