.. currentmodule:: hydromt_wflow

.. _api_reference:

#############
API reference
#############

.. _api_model:

Wflow model class
=================

Initialize
----------

.. autosummary::
   :toctree: _generated

   WflowModel

.. _components:

Setup components
----------------

.. autosummary::
   :toctree: _generated

   WflowModel.setup_config
   WflowModel.setup_basemaps
   WflowModel.setup_rivers
   WflowModel.setup_floodplains
   WflowModel.setup_lakes
   WflowModel.setup_reservoirs
   WflowModel.setup_glaciers
   WflowModel.setup_lulcmaps
   WflowModel.setup_lulcmaps_from_vector
   WflowModel.setup_lulcmaps_with_paddy
   WflowModel.setup_laimaps
   WflowModel.setup_laimaps_from_lulc_mapping
   WflowModel.setup_allocation_areas
   WflowModel.setup_allocation_surfacewaterfrac
   WflowModel.setup_domestic_demand
   WflowModel.setup_domestic_demand_from_population
   WflowModel.setup_other_demand
   WflowModel.setup_irrigation
   WflowModel.setup_irrigation_from_vector
   WflowModel.setup_ksathorfrac
   WflowModel.setup_ksatver_vegetation
   WflowModel.setup_rootzoneclim
   WflowModel.setup_soilmaps
   WflowModel.setup_outlets
   WflowModel.setup_gauges
   WflowModel.setup_areamap
   WflowModel.setup_config_output_timeseries
   WflowModel.setup_precip_forcing
   WflowModel.setup_precip_from_point_timeseries
   WflowModel.setup_temp_pet_forcing
   WflowModel.setup_pet_forcing
   WflowModel.setup_constant_pars
   WflowModel.setup_1dmodel_connection
   WflowModel.setup_grid_from_raster
   WflowModel.setup_cold_states

Attributes
----------

.. autosummary::
   :toctree: _generated

   WflowModel.region
   WflowModel.crs
   WflowModel.res
   WflowModel.root
   WflowModel.config
   WflowModel.grid
   WflowModel.geoms
   WflowModel.forcing
   WflowModel.states
   WflowModel.results
   WflowModel.tables
   WflowModel.flwdir
   WflowModel.basins
   WflowModel.rivers

High level methods
------------------

.. autosummary::
   :toctree: _generated

   WflowModel.read
   WflowModel.write
   WflowModel.build
   WflowModel.update
   WflowModel.set_root

General methods
---------------

.. autosummary::
   :toctree: _generated


   WflowModel.setup_config
   WflowModel.get_config
   WflowModel.set_config
   WflowModel.read_config
   WflowModel.write_config

   WflowModel.set_grid
   WflowModel.read_grid
   WflowModel.write_grid
   WflowModel.clip_grid

   WflowModel.set_geoms
   WflowModel.read_geoms
   WflowModel.write_geoms

   WflowModel.set_forcing
   WflowModel.read_forcing
   WflowModel.write_forcing
   WflowModel.clip_forcing

   WflowModel.set_states
   WflowModel.read_states
   WflowModel.write_states
   WflowModel.clip_states

   WflowModel.set_results
   WflowModel.read_results

   WflowModel.set_tables
   WflowModel.read_tables
   WflowModel.write_tables

   WflowModel.set_flwdir

.. _api_model_sediment:

WflowSediment model class
=========================

Initialize
----------

.. autosummary::
   :toctree: _generated

   WflowSedimentModel

.. _components_sediment:

Setup components
----------------

.. autosummary::
   :toctree: _generated

   WflowSedimentModel.setup_config
   WflowSedimentModel.setup_basemaps
   WflowSedimentModel.setup_rivers
   WflowSedimentModel.setup_lakes
   WflowSedimentModel.setup_reservoirs
   WflowSedimentModel.setup_lulcmaps
   WflowSedimentModel.setup_lulcmaps_from_vector
   WflowSedimentModel.setup_laimaps
   WflowSedimentModel.setup_laimaps_from_lulc_mapping
   WflowSedimentModel.setup_canopymaps
   WflowSedimentModel.setup_soilmaps
   WflowSedimentModel.setup_riverwidth
   WflowSedimentModel.setup_riverbedsed
   WflowSedimentModel.setup_outlets
   WflowSedimentModel.setup_gauges
   WflowSedimentModel.setup_areamap
   WflowSedimentModel.setup_config_output_timeseries
   WflowSedimentModel.setup_constant_pars
   WflowSedimentModel.setup_grid_from_raster

Attributes
----------

.. autosummary::
   :toctree: _generated

   WflowSedimentModel.region
   WflowSedimentModel.crs
   WflowSedimentModel.res
   WflowSedimentModel.root
   WflowSedimentModel.config
   WflowSedimentModel.grid
   WflowSedimentModel.geoms
   WflowSedimentModel.forcing
   WflowSedimentModel.states
   WflowSedimentModel.results
   WflowSedimentModel.flwdir
   WflowSedimentModel.basins
   WflowSedimentModel.rivers

High level methods
------------------

.. autosummary::
   :toctree: _generated

   WflowSedimentModel.read
   WflowSedimentModel.write
   WflowSedimentModel.build
   WflowSedimentModel.update
   WflowSedimentModel.set_root

General methods
---------------

.. autosummary::
   :toctree: _generated

   WflowSedimentModel.setup_config
   WflowSedimentModel.get_config
   WflowSedimentModel.set_config
   WflowSedimentModel.read_config
   WflowSedimentModel.write_config

   WflowSedimentModel.set_grid
   WflowSedimentModel.read_grid
   WflowSedimentModel.write_grid
   WflowSedimentModel.clip_grid

   WflowSedimentModel.set_geoms
   WflowSedimentModel.read_geoms
   WflowSedimentModel.write_geoms

   WflowSedimentModel.set_forcing
   WflowSedimentModel.read_forcing
   WflowSedimentModel.write_forcing
   WflowSedimentModel.clip_forcing

   WflowSedimentModel.set_states
   WflowSedimentModel.read_states
   WflowSedimentModel.write_states

   WflowSedimentModel.set_results
   WflowSedimentModel.read_results

   WflowSedimentModel.set_flwdir

.. _workflows:

Wflow workflows
===============

.. autosummary::
   :toctree: _generated

   workflows.allocation_areas
   workflows.surfacewaterfrac_used
   workflows.domestic
   workflows.domestic_from_population
   workflows.other_demand
   workflows.irrigation
   workflows.irrigation_from_vector
   workflows.hydrography
   workflows.topography
   workflows.river
   workflows.river_bathymetry
   workflows.pet
   workflows.spatial_interpolation
   workflows.landuse
   workflows.landuse_from_vector
   workflows.lai
   workflows.create_lulc_lai_mapping_table
   workflows.lai_from_lulc_mapping
   workflows.add_paddy_to_landuse
   workflows.add_planted_forest_to_landuse
   workflows.ksathorfrac
   workflows.ksatver_vegetation
   workflows.soilgrids
   workflows.soilgrids_sediment
   workflows.soilgrids_brooks_corey
   workflows.update_soil_with_paddy
   workflows.waterbodymaps
   workflows.reservoirattrs
   workflows.lakeattrs
   workflows.glaciermaps
   workflows.glacierattrs
   workflows.rootzoneclim
   workflows.wflow_1dmodel_connection
   workflows.prepare_cold_states


.. _methods:

Wflow low-level methods
=======================

Input/Output methods
---------------------

.. autosummary::
   :toctree: _generated

   read_csv_results
   pcrm.read_staticmaps_pcr
   pcrm.write_staticmaps_pcr

Utility methods
---------------

.. autosummary::
   :toctree: _generated

   utils.get_grid_from_config