# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "HGDMr" in publications use:'
type: software
license: GPL-3.0-only
title: 'HGDMr: Hysteretic and Gatekeeping Depressions Model'
version: 1.0.0
identifiers:
- type: doi
  value: 10.32614/CRAN.package.HGDMr
abstract: Implementation of the Hysteretic and Gatekeeping Depressions Model (HGDM)
  which calculates variable connected/contributing areas and resulting discharge volumes
  in prairie basins dominated by depressions ("slough" or "potholes"). The small depressions
  are combined into a single "meta" depression which explicitly models the hysteresis
  between the storage of water and the connected/contributing areas of the depressions.
  The largest (greater than 5% of the total depressional area) depression (if it exists)
  is represented separately to model its gatekeeping, i.e. the blocking of upstream
  flows until it is filled. The methodolgy is described in detail in Shook and Pomeroy
  (2025, <https://doi.org/10.1016/j.jhydrol.2025.132821>).
authors:
- family-names: Shook
  given-names: Kevin
  email: kevin.shook@usask.ca
preferred-citation:
  type: manual
  title: HGDMr - Hysteretic and Gatekeeping Depressions Model
  authors:
  - family-names: Shook
    given-names: Kevin
    email: kevin.shook@usask.ca
  year: '2025'
  notes: R package version 1.0.0
repository: https://centreforhydrology.r-universe.dev
repository-code: https://github.com/CentreForHydrology/HGDMr
commit: db262b630604138a69b0b75734d9764cba52c41a
url: https://github.com/CentreForHydrology/HGDMr
date-released: '2025-02-19'
contact:
- family-names: Shook
  given-names: Kevin
  email: kevin.shook@usask.ca
references:
- type: article
  title: The hysteretic and gatekeeping depressions model - A new model for variable
    connected fractions of prairie basins
  authors:
  - family-names: Shook
    given-names: Kevin Robert
  - family-names: Pomeroy
    given-names: John Willard
  journal: Journal of Hydrology
  volume: '654'
  url: https://doi.org/10.1016/j.jhydrol.2025.132821
  year: '2025'
  start: '132821'