Skip to content

Commit

Permalink
document tdating (#245)
Browse files Browse the repository at this point in the history
* edit

* update to TDATING example and reference file, added publication for reference
  • Loading branch information
feldmann-m committed Dec 2, 2021
1 parent 96a0ddc commit f09c925
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
10 changes: 10 additions & 0 deletions doc/source/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -294,3 +294,13 @@ @ARTICLE{TRT2004
YEAR = 2004
}

@ARTICLE{Feldmann2021,
AUTHOR = "M. Feldmann and U. Germann and M. Gabella and A. Berne",
TITLE = "A Characterisation of Alpine Mesocyclone Occurrence",
JOURNAL = "Weather and Climate Dynamics Discussions",
PAGES = "1--26",
URL = "https://wcd.copernicus.org/preprints/wcd-2021-53/",
DOI = "10.5194/wcd-2021-53"
YEAR = 2021
}

10 changes: 6 additions & 4 deletions examples/thunderstorm_detection_and_tracking.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Thunderstorm Detection and Tracking - DATing
Thunderstorm Detection and Tracking - T-DaTing
============================================
This example shows how to use the thunderstorm DATing module. The example is based on
This example shows how to use the thunderstorm DaTing module. The example is based on
MeteoSwiss radar data and uses the Cartesian composite of maximum reflectivity on a
1 km grid. All default values are tuned to this grid, but can be modified.
The first section demonstrates thunderstorm cell detection and how to plot contours.
Expand All @@ -13,13 +13,15 @@
This module was implemented following the procedures used in the TRT Thunderstorms
Radar Tracking algorithm (:cite:`TRT2004`) used operationally at MeteoSwiss.
Modifications include advecting the identified thunderstorms with the optical flow
obtained from pysteps, as well as additional options in the thresholding.
obtained from pysteps, as well as additional options in the thresholding. A detailed
description is published in Appendix A of :cite: 'Feldmann2021'.
References
..........
:cite:`TRT2004`
:cite: 'Feldmann2021'
@author: mfeldman
@author: feldmann-m
"""
################################################################################
# Import all required functions
Expand Down

0 comments on commit f09c925

Please sign in to comment.