===================
API  Documentation
===================


Core Classes
------------

Model
~~~~~
.. automodule:: rompy.model
    :members:
    :inherited-members: BaseModel
    :no-index:

Config
~~~~~~
.. automodule:: rompy.core.config
    :members:
    :inherited-members: BaseModel
    :no-index:

Time
~~~~
.. automodule:: rompy.core.time
    :members:
    :inherited-members: BaseModel
    :no-index:

Grid
~~~~
.. automodule:: rompy.core.grid
    :members:
    :inherited-members: BaseModel
    :no-index:

Data
~~~~
.. automodule:: rompy.core.data
    :members:
    :inherited-members: BaseModel
    :no-index:

Filters
~~~~~~~
.. automodule:: rompy.core.filters
    :members:
    :inherited-members: BaseModel
    :no-index:

Boundary
~~~~~~~~
.. automodule:: rompy.core.render
    :members:
    :inherited-members: BaseModel
    :no-index:

Types
~~~~~
.. automodule:: rompy.core.types
    :members:
    :inherited-members: BaseModel
    :no-index:


Swan classes
------------

Config
~~~~~~
.. automodule:: rompy.swan.config
    :members:
    :inherited-members: BaseModel
    :no-index:

Grid
~~~~
.. automodule:: rompy.swan.grid
    :members:
    :inherited-members: BaseModel
    :no-index:

Data
~~~~
.. automodule:: rompy.swan.data
    :members:
    :inherited-members: BaseModel
    :no-index:

Boundary
~~~~~~~~
.. automodule:: rompy.swan.boundary
    :members:
    :inherited-members: BaseModel
    :no-index:

Types
~~~~~
.. automodule:: rompy.swan.types
    :members:
    :inherited-members: BaseModel
    :no-index:


Swan components
---------------

Base
~~~~
.. automodule:: rompy.swan.components.base
    :members:
    :inherited-members: BaseModel
    :no-index:

Group
~~~~~
.. automodule:: rompy.swan.components.group
    :members:
    :inherited-members: BaseModel
    :no-index:

Startup
~~~~~~~
.. automodule:: rompy.swan.components.startup
    :members:
    :inherited-members: BaseModel
    :no-index:

Cgrid
~~~~~
.. automodule:: rompy.swan.components.cgrid
    :members:
    :inherited-members: BaseModel
    :no-index:

Inpgrid
~~~~~~~
.. automodule:: rompy.swan.components.inpgrid
    :members:
    :inherited-members: BaseModel
    :no-index:

Boundary
~~~~~~~~
.. automodule:: rompy.swan.components.boundary
    :members:
    :inherited-members: BaseModel
    :no-index:

Physics
~~~~~~~
.. automodule:: rompy.swan.components.physics
    :members:
    :inherited-members: BaseModel
    :no-index:

Numerics
~~~~~~~~
.. automodule:: rompy.swan.components.numerics
    :members:
    :inherited-members: BaseModel
    :no-index:


Swan subcomponents
------------------

Base
~~~~
.. automodule:: rompy.swan.subcomponents.base
    :members:
    :inherited-members: BaseModel
    :no-index:

Startup
~~~~~~~
.. automodule:: rompy.swan.subcomponents.startup
    :members:
    :inherited-members: BaseModel
    :no-index:

Spectrum
~~~~~~~~
.. automodule:: rompy.swan.subcomponents.spectrum
    :members:
    :inherited-members: BaseModel
    :no-index:

Time
~~~~
.. automodule:: rompy.swan.subcomponents.time
    :members:
    :inherited-members: BaseModel
    :no-index:

Readgrid
~~~~~~~~
.. automodule:: rompy.swan.subcomponents.readgrid
    :members:
    :inherited-members: BaseModel
    :no-index:

Boundary
~~~~~~~~
.. automodule:: rompy.swan.subcomponents.boundary
    :members:
    :inherited-members: BaseModel
    :no-index:

Physics
~~~~~~~
.. automodule:: rompy.swan.subcomponents.physics
    :members:
    :inherited-members: BaseModel
    :no-index:

Numerics
~~~~~~~~
.. automodule:: rompy.swan.subcomponents.numerics
    :members:
    :inherited-members: BaseModel
    :no-index: