.. _home:

**********
WRIMS Docs
**********

.. note::

   This documentation project is under active development. These subprojects are 
   incomplete, and changes may occur to the content or the structure at any time.

The **W**\ ater **R**\ esource **I**\ ntegrated **M**\ odeling **S**\ ystem 
(WRIMS) is a generalized water resources modeling system for evaluating 
operational alternatives of large, complex river basins. WRIMS integrates a 
simulation language for flexible operational criteria specification, linear 
programming solvers for used to simulate efficient water allocation decisions, 
and graphics capabilities to gain insights from model results. These combined 
capabilities provide a comprehensive and powerful modeling tool for water 
resource systems simulation.

Documentation on the use and development for WRIMS is split into three 
locations that correspond to the technical topics being addressed. Each of 
these pages also correspond to a GitHub repositiory. 

WRIMS Engine
------------

.. _WRIMS Engine Repo: https://github.com/CentralValleyModeling/wrims-engine


- "Headless" usage of WRIMS, such as running a model from a ``.bat`` file.
- Documentation on the format of non-WRESL+ input files.

+------+---------------------------------------------+
| Docs | :ref:`WRIMS Engine Docs<wrims-engine:home>` |
+------+---------------------------------------------+
| Code | `WRIMS Engine Repo`_                        |
+------+---------------------------------------------+

WRIMS GUI
---------

.. _WRIMS GUI Repo: https://github.com/CentralValleyModeling/wrims-gui

- Use of the WRIMS GUI, including how to run a model in debug mode.
- How to use the schematic editor.
- How to use the DSS file uilities within WRIMS.
- How to edit WRESL+ files within WRIMS.

+------+---------------------------------------------+
| Docs | :ref:`WRIMS GUI Docs<wrims-gui:home>`       |
+------+---------------------------------------------+
| Code | `WRIMS GUI Repo`_                           |
+------+---------------------------------------------+

WRESL+
------

.. _WRESL+ Repo: https://github.com/CentralValleyModeling/wresl

- References for the syntax for the various WRESL+ objects.
- The WRESL+ style guide.

+------+---------------------------------------------+
| Docs | :ref:`WRESL+ Docs<wresl:index>`             |
+------+---------------------------------------------+
| Code | `WRESL+ Repo`_                              |
+------+---------------------------------------------+

WRIMS Docs
----------

This project (the one you're looking at right now) is used to centralize some 
of the processes, and it links everything together on the Read the Docs 
platform. 

- Learn how to contribute to the various WRIMS documentation projects.
- Documentation style guide. 

Site Content
~~~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    Contribute<contribution-guide>