Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dougiesquire committed Feb 29, 2024
1 parent 1983bd2 commit 69a43b4
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/datastores/builders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The access-nri-intake package is installed in the :code:`hh5` and :code:`xp65` a
users can install it into their own environment (see :ref:`installation` for details). The Builders can be
imported from the :code:`access_nri_intake.source.builders` submodule.

There are currently three Builders available. Their core public APIs are given below (their full APIs can be
There are currently four Builders available. Their core public APIs are given below (their full APIs can be
found in :ref:`source_api`).

.. note::
Expand All @@ -39,8 +39,15 @@ ACCESS-CM2 output: :code:`AccessCm2Builder`
:special-members: __init__, build, save
:noindex:

ACCESS-OM3 output: :code:`AccessOm3Builder`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: access_nri_intake.source.builders.AccessOm3Builder
:special-members: __init__, build, save
:noindex:

.. note::

If you have ACCESS model output that isn't compatible with the existing set of Builders, check out the
:ref:`builder_create` section or open an issue
`here <https://github.com/ACCESS-NRI/access-nri-intake-catalog/issues/new/choose>`_.
`here <https://github.com/ACCESS-NRI/access-nri-intake-catalog/issues/new/choose>`_.

0 comments on commit 69a43b4

Please sign in to comment.