Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ACCESS-OM3 builder #152

Merged
merged 5 commits into from
Mar 1, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update docs
  • Loading branch information
dougiesquire committed Feb 29, 2024
commit 69a43b4eff5eb7081c4daa8a8b3a827d7b92022e
11 changes: 9 additions & 2 deletions docs/datastores/builders.rst
Original file line number Diff line number Diff line change
@@ -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::
@@ -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>`_.