.. DyPy documentation master file, created by
   sphinx-quickstart on Thu Mar 21 13:19:53 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

DyPy documentation
==================

DyPy is a generic Python backward dynamic programming solver focused on ease and flexibility.
It tries to provide simple, and easy to use defaults that can be overridden to build larger
and more complex dynamic programs. Further, it is permissively licensed and is a full Python
package with (at least some) tests to ensure integrity of solutions.

DyPy is still very new and caution should be exercised in using it. The code base is still seeing large changes
which may or may not break existing functionality. It currently is tested against a few small problems, but those
tests may or may not work on a given day. `Get in touch <https://watershed.ucdavis.edu/user/64/contact>`_ if you have questions or want to contribute. If you just need
a working dynamic programming library now, check out `ProDyn <https://prodyn.readthedocs.io/en/latest/index.html>`_


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   conceptual_overview
   examples
   api

DyPy was authored by `Nick Santos <https://nicksantos.com/>`_

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`