Skip to content

Commit ba16ff6

Browse files
committed
Update api.rst
1 parent 3f2b723 commit ba16ff6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ Xarray-simlab
6464

6565
Since XSO mostly wraps `xarray-simlab <https://xarray-simlab.readthedocs.io/en/latest/>`_, it can be helpful to also reference that API.
6666

67+
* The :deco:`xso.component`decorator function returns a fully functional :deco:`xsimlab:xsimlab.process` class.
68+
* The :func:`xso.create` function returns a :class:`xsimlab:xsimlab.Model` instance.
69+
* The :func:`xso.setup` function is a light wrapper around :func:`xsimlab:xsimlab.create_setup`.
70+
* All *variable types* are represented in the model as :func:`xsimlab:xsimlab.variable` instances.
71+
6772
We can access the xarray-simlab API through the ``xsimlab`` accessor of the created input and output xarray Datasets:
6873

6974
.. code-block:: python

0 commit comments

Comments
 (0)