Skip to content

Guo-Badger/STEP

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Please note that this is only a preliminary version of the package and is not actively maintained.

STEP (Storm Tracking and Evaluation Protocol)

STEP is a Python package that identifies, tracks, and computes physical characteristics of rainstorms given spatiotemporal precipitation data. The algorithms herein are implementations of those proposed by Chang et al. in Changes in Spatiotemporal Precipitation Patterns in Changing Climate Conditions, released by the Center for Robust Decision-making on Climate and Energy Policy. For implementation details, see the wiki.

Note: Due to the time and space complexity of the computations used to track storms, it is highly recommended that runs of any substance be done on machines designed specifically for tasks of such computational weight.

Summary

  • Installation
  • Dependencies
  • Usage
  • Notes on Methodology
  • Contributing
  • License
  • Authors
  • Acknowledgements

Installation

To install STEP:

  1. Download the repository and unzip it.
  2. cd to the root directory where setup.py can be found.
  3. Execute $ python setup.py install.

Dependencies

Name Version
imageio 2.8.0
Matplotlib 3.2.1
netCDF4 1.5.3
NumPy 1.18.5
scikit-image 0.17.2
SciPy 1.4.1

Basemap is necessary when using the example plotting function storms_with_map found in the Tutorial. Additionally, the results of the package can be plotted using your visualization library of choice.

Usage

Please see the Tutorial for a comprehensive introduction to package use. See Implementation Details for function signatures and usage tips. You can also call help(function) for information on these and functions called therein. Depending on the function, calling help may provide more info.

Notes on Methodology

For more detailed information, see the Methodology or the original publication and its supplemental materials. Please also see the original publication for more information on the reasoning behind the algorithms and the mathematics used.

Contributing

If you would like to propose a change and/or note an error, please open an issue first to discuss what needs improvement (and, if applicable, how that might be accomplished).

License

STEP is released under the 'Add a license here' license.

Authors

Acknowledgements

  • Won Chang - research
  • Michael Stein - research
  • Jiali Wang - research
  • Rao Kotamarthi - research
  • Elisabeth Moyer - research
  • Benjamin Kleeman - guidance on project structure and docs
  • Emily Padston - project management and guidance

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%