.. DamPythonInterface documentation master file, created by
   sphinx-quickstart on Mon Sep 13 15:34:22 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DamPythonInterface's documentation!
==============================================

DamPythonInterface is a Python package to generate input for the DAM engine basically bypassing the DAM UI.
Release v\ |version|.

Introduction
============
DamPythonInterface is a tool that basically contains three different functionalities:

* A skeleton of the inputs required to run the DAMEngine.
* The ability of writing an input xml file for the DAMEngine.
* The ability of running the DAMEngine.

Therefore, the user can use this tool to create xml input files with inputs that can be specified from Python.


This part of the documentation covers the installation of DamPythonInterface.
The first step to using any software package is getting it properly installed.

DamPythonInterface installation
-------------------------------
DamPythonInterface releases defined as .whl files. You can download these and install such files with::

    $ pip install geolib-0.1.0-py3-none-any.whl


Packages used
-------------

This package, tries to limit the number of
*heavy* depedencies. The main packages used are:

- Poetry_ for package management (replacing setuptools) see also `PEP 518 <https://www.python.org/dev/peps/pep-0518/>`_.
- Pydantic_ for validation of types and some parameters (min/max/defaults).

.. _Poetry: https://python-poetry.org/docs/
.. _Pydantic: https://pydantic-docs.helpmanual.io/

You don't need to install anything manually, as the pip installation should take care of it.

Tutorial
--------
The tutorial can be found in :doc:`this document. <tutorial>` 

The total interface documentation
---------------------------------

This part of the documentation contains all input classes that can be used to create a DAM engine input xml.

.. toctree::
   :maxdepth: 3

   dev/input

Tips for Python development
===========================
For more tips refer :doc:`this document. <dev/tips>` 

Release notes
=============
The release notes can be found in :doc:`this document. <release_notes>` 

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

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