hydrological_modules package
****************************

Initialize
==========

miscInitial module
------------------

**Initializing some variables**

.. automodule:: cwatm.hydrological_modules.miscInitial
    :members:
    :undoc-members:
    :show-inheritance:

initcondition module
--------------------

**Load initial storage parameter maps**

.. automodule:: cwatm.hydrological_modules.initcondition
    :members:
    :undoc-members:
    :show-inheritance:

landcoverType module
--------------------

**Generate landcover types**
 
.. automodule:: cwatm.hydrological_modules.landcoverType
    :members:
    :undoc-members:
    :show-inheritance:

Hydrology I - from rain to soil
===============================

readmeteo module
----------------

**Read meteorological input data**

.. automodule:: cwatm.hydrological_modules.readmeteo
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:


inflow module
-------------

**Read river discharge time series as inflow data**

.. automodule:: cwatm.hydrological_modules.inflow
    :members:
    :undoc-members:
    :show-inheritance:


snow_frost module
-----------------

**Calculate snow and frost**

.. automodule:: cwatm.hydrological_modules.snow_frost
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:
	

evaporationPot module
---------------------

**Calculate potential Evaporation**

.. automodule:: cwatm.hydrological_modules.evaporationPot
    :members:
    :undoc-members:
    :show-inheritance:


evaporation module
------------------

**Calculate actual evapotranspiration**

.. automodule:: cwatm.hydrological_modules.evaporation
    :members:
    :undoc-members:
    :show-inheritance:

interception module
-------------------

**Calculate interception**

.. automodule:: cwatm.hydrological_modules.interception
    :members:
    :undoc-members:
    :show-inheritance:

sealed_water module
-------------------

**Calculate water runoff from impermeable surface**

.. automodule:: cwatm.hydrological_modules.sealed_water
    :members:
    :undoc-members:
    :show-inheritance:	


Hydrology II - from soil to river
=================================

soil module
-----------

**Calculate fluxes in 3 layer soil**

.. automodule:: cwatm.hydrological_modules.soil
    :members:
    :undoc-members:
    :show-inheritance:

capillarRise module
-------------------

**Calculate capillar rise from groundwater**

.. automodule:: cwatm.hydrological_modules.capillarRise
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
	
groundwater module
------------------

**Calculate groundwater**

.. automodule:: cwatm.hydrological_modules.groundwater
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
	
runoff_concentration module
---------------------------

**Calculate runoff concentration - from grid cell to grid cell corner**

.. automodule:: cwatm.hydrological_modules.runoff_concentration
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:	


Hydrology III - Socio-economic - Water demand
=============================================

water_demand.water_demand
-------------------------

**Calculate water demand from different sectors**

.. automodule:: cwatm.hydrological_modules.water_demand.water_demand
    :members:
    :undoc-members:
    :show-inheritance:

water_demand.domestic
---------------------

**Read water demand for domestic**

.. automodule:: cwatm.hydrological_modules.water_demand.domestic
    :members:
    :undoc-members:
    :show-inheritance:

water_demand.industry
---------------------

**Read water demand for industry**

.. automodule:: cwatm.hydrological_modules.water_demand.industry
    :members:
    :undoc-members:
    :show-inheritance:

water_demand.livestock
----------------------

**Read water demand for livestock**

.. automodule:: cwatm.hydrological_modules.water_demand.livestock
    :members:
    :undoc-members:
    :show-inheritance:

water_demand.irrigation
-----------------------

**Calculate water demand for irrigation**

.. automodule:: cwatm.hydrological_modules.water_demand.irrigation
    :members:
    :undoc-members:
    :show-inheritance:

water_demand.environmental_need
-------------------------------

**Read water for environmental need**

.. automodule:: cwatm.hydrological_modules.water_demand.environmental_need
    :members:
    :undoc-members:
    :show-inheritance:

Hydrology IV - Lakes, reservoirs and river
==========================================
	
lakes_reservoirs module
-----------------------

**Calculate water retention in lakes**

.. automodule:: cwatm.hydrological_modules.lakes_reservoirs
    :members:
    :undoc-members:
    :show-inheritance:

lakes_res_small module
----------------------

**Calculate water retention in small lakes**

.. automodule:: cwatm.hydrological_modules.lakes_res_small
    :members:
    :undoc-members:
    :show-inheritance:
	
routing_reservoirs.routing_kinematic module
-------------------------------------------

**River routing - kinematic wave**

.. automodule:: cwatm.hydrological_modules.routing_reservoirs.routing_kinematic
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:


routing_reservoirs.routing_sub module
-------------------------------------

**Sub routines for river routing**

.. automodule:: cwatm.hydrological_modules.routing_reservoirs.routing_sub
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:

Hydrology V - Water balance
===========================

waterbalance module
-------------------

.. automodule:: cwatm.hydrological_modules.waterbalance
    :members:
    :undoc-members:
    :show-inheritance:	



.. automodule:: cwatm.hydrological_modules
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members: