Flood estimation library
  • 1. Tutorial and introduction to floodestimation
    • 1.1. Installation and requirements
    • 1.2. Typical workflow
  • 2. Reference manual
    • 2.1. floodestimation.entities — Core components
    • 2.2. floodestimation.parsers — Parsing FEH data files
    • 2.3. floodestimation.fehdata — Accessing gauged catchment data
    • 2.4. floodestimation.db — Storing gauged catchment data in sqlite database
    • 2.5. floodestimation.loaders — Loading catchment data quickly
    • 2.6. floodestimation.collections — Common sets of catchments
    • 2.7. floodestimation.analysis — Flood estimation analyses
 
Flood estimation library
  • Docs »
  • 2. Reference manual
  • Edit on GitHub

2. Reference manualΒΆ

  • 2.1. floodestimation.entities — Core components
    • 2.1.1. Catchment — The catchment object
    • 2.1.2. Descriptors — A set of catchment descriptors
    • 2.1.3. AmaxRecord — Annual maximum flow records
    • 2.1.4. PotDataset — Peaks-over-threshold datasets
    • 2.1.5. PotRecord — Peaks-over-threshold records
    • 2.1.6. PotDataGap — Peaks-over-threshold data gaps
    • 2.1.7. Comment — Catchment comments
    • 2.1.8. Point — Point coordinates
  • 2.2. floodestimation.parsers — Parsing FEH data files
    • 2.2.1. FehFileParser — Base file parser class
    • 2.2.2. Cd3Parser — Parsing catchment files
    • 2.2.3. XmlCatchmentParser — Parsing catchments saved as xml files
    • 2.2.4. AmaxParser — Parsing annual maximum flow records
    • 2.2.5. PotParser — Parsing peaks-over-threshold (POT) records
  • 2.3. floodestimation.fehdata — Accessing gauged catchment data
  • 2.4. floodestimation.db — Storing gauged catchment data in sqlite database
  • 2.5. floodestimation.loaders — Loading catchment data quickly
  • 2.6. floodestimation.collections — Common sets of catchments
  • 2.7. floodestimation.analysis — Flood estimation analyses
    • 2.7.1. Analysis — Generic analysis object
    • 2.7.2. QmedAnalysis — Estimating the median annual flood
    • 2.7.3. GrowthCurveAnalysis — Estimating the flood growth curve
    • 2.7.4. GrowthCurve — The flood growth curve object
Next Previous

© Copyright 2014β€’2016, Open Hydrology contributors. Last updated on 22/01/2016.

Built with Sphinx using a theme provided by Read the Docs.