.. _home:

WRIMS Engine
============

.. note::

   This documentation is a work in progress. Pages are being added over time.
   If you need guidance on a topic not yet covered here, please reach out to
   your project team or consult the in-application help.

Getting Started
---------------

If you are new to WRIMS, the recommended path is:

1. Install WRIMS GUI. Starting out with WRIMS Engine is probably not the best
   entry point.
2. Check out the :ref:`WRIMS GUI Docs<wrims-gui:home>` to learn how to use
   WRIMS from the graphical interface.
3. When you are ready to run studies programmatically or in batch, refer to the
   headless guide here: :ref:`headless`.

Contents
--------

How To
^^^^^^

- :ref:`headless`

Reference
^^^^^^^^^

- :ref:`Configuration File Structure <configuration>`

.. note::

   The **Configuration File Structure** page is not yet written. The entry above
   is a placeholder to show where it will appear in the navigation.

About WRIMS
-----------
or planning and
operational studies of the State Water Project and the Central Valley water
system, though its general modeling framework can be applied to other
large-scale water resource networks.
WRIMS is developed and maintained by the `California Department of Water
Resources <https://water.ca.gov/>`_. It is primarily used f

The engine solves a linear program at each cycle/timestep to determine optimal
allocations and deliveries given the network topology, physical constraints,
and operational priorities defined in the study configuration.