``schism``
==========

.. include:: ../shared/idempotent.rst

The ``uw`` mode for configuring and running the :schism:`SCHISM<>` component.

.. include:: help.rst

Examples
^^^^^^^^

The examples use a configuration file named ``config.yaml`` with content similar to:

.. highlight:: yaml
.. literalinclude:: /shared/drivers/schism.yaml

Its contents are described in depth in section :ref:`schism_yaml`. A Python ``datetime`` object named ``cycle`` is available for use in Jinja2 variables/expressions in the config.

* Create a provisioned run directory:

  .. code-block:: text

     $ uw schism provisioned_rundir --config-file config.yaml --cycle 2024-10-21T12

* Validate the config file:

  .. code-block:: text

     $ uw schism validate --config-file config.yaml --cycle 2024-10-21T12

.. include:: /shared/key_path.rst

.. include:: schema-options.rst