https://github.com/cemac/stormtrackingscripts

THIS REPO IS ARCHIVED. Development of Scripts from ICAS dynamics group

https://github.com/cemac/stormtrackingscripts

Keywords

Repository

THIS REPO IS ARCHIVED. Development of Scripts from ICAS dynamics group

https://github.com/cemac/StormTrackingScripts/blob/master/

  
  



# Storm Tracking Scripts #

[![DOI](https://zenodo.org/badge/148126570.svg)](https://zenodo.org/badge/latestdoi/148126570) [![GitHub release](https://img.shields.io/github/release/cemac/StormTrackingScripts.svg)](https://github.com/cemac/StormTrackingScripts/releases) [![GitHub top language](https://img.shields.io/github/languages/top/cemac/StormTrackingScripts.svg)](https://github.com/cemac/StormTrackingScripts) [![GitHub issues](https://img.shields.io/github/issues/cemac/StormTrackingScripts.svg)](https://github.com/cemac/StormTrackingScripts/issues) [![GitHub last commit](https://img.shields.io/github/last-commit/cemac/StormTrackingScripts.svg)](https://github.com/cemac/StormTrackingScripts/commits/master) [![GitHub All Releases](https://img.shields.io/github/downloads/cemac/StormTrackingScripts/total.svg)](https://github.com/cemac/StormTrackingScripts/releases)
[![HitCount](http://hits.dwyl.com/{cemac}/{StormTrackingScripts}.svg)](http://hits.dwyl.com/{cemac}/{StormTrackingScripts})

## Description ##

Development of Storm Tracking Scripts from ICAS dynamics group.


# Version 2.0 #

The first major release of developed scripts. Building from Rory's storm tracking scripts these functions have been moved a modular system. Finding storms in an area, extracting information about those storms and calculating some statistics about those storms and producing a set of Standard plots.

## New Features ##

* Removed Hardcoding, can be used on different model runs, easily adapted for different variable etc
* Runs in Parallel - giving a speed improvement
* Python 3 version available
* Reduction in lines of code from 3600 to 1100
* Large increase in comments docstrings

## Possible Upcoming Features ##

1. Documentation improvements
2. STASH code variable library
3. Feature requests
4. Switch to CF-python
5. minor speed up
6. Python GUI

## Requirements ##

 * [Python](https://www.anaconda.com/download/) (Standard anaconda package)

A full list of Requirements is listed in the yml files (python 3). installing via setup.py will account for requirements.



# Installation (recommended method) #

Storm Scripts requires a few non-standard modules (skewt, meteocalc). anaconda or miniconda is the recommended method of Installation.

## Python 2 ##

```bash

# download anaconda installer
wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh
bash Miniconda2-latest-Linux-x86_64.sh #skip if you already have anaconda
export PATH="$HOME/miniconda3/bin:$PATH" #skip if you already have anaconda
cd StormTrackingScripts
conda env create -f StormScripts_py2.yml
conda activate StormS
conda clean -t
cd Storm_Scripts_py2
python StormScriptsPy2/setup.py install
```

## Python 3 ##

*SkewT python 3 support is not yet in the anaconda cloud coming soon, for now an
extra step is required*

````bash

# download anaconda installer
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh #skip if you already have anaconda
export PATH="$HOME/miniconda3/bin:$PATH" #skip if you already have anaconda
cd StormTrackingScripts
conda env create -f StormScripts_py3.yml
conda activate StormS
git clone https://github.com/tjlang/SkewT.git
cd SkewT
python setup.py install
conda clean -t
cd Storm_Scripts
python StormScriptsPy3/setup.py install
````



# Usage #

Either have installed the module or added to python path.

Can be used to find a subset of storms from the precip_tracking_12km_hourly
text files and mine the relevant data. Comes with plotting tools.

```Python

from os.path import expanduser
import numpy as np
import pandas as pd
import StormScriptsPy3 as SSP3

# print some help?
SSP3.S_Box.StormInBox?
# Define your storms
c = SSP3.S_Box.StormInBox(345, 375, 10, 18, 5000, 'cc_storms_')
# generate the list of storms
c.gen_storm_box_csv()
# point to data and if you want the full set of calculations done
dmf = SSP3.dm_functions('/path/to/data/', CAPE='Y', TEPHI='Y')
dmf.genvarscsv('cc_storms_', pd.read_csv('generated_file.csv', sep=',')

```




## Issue Templates ##

* A full guide on submitting issue and bug are given in our [contribution guidelines](https://github.com/cemac/StormTrackingScripts/blob/master/CONTRIBUTING.md)
* Please use our issue templates for feature requests and bug fixes.



## Acknowledgements ##
These scripts have been developed based on the work done by the [Institute of Climate and Atmospheric Science (ICAS)](http://www.see.leeds.ac.uk/research/icas/) [dynamics](http://www.see.leeds.ac.uk/research/icas/research-themes/atmosphere/) group and the University of Leeds. This work was originally part of the [African Monsoon Multidisciplinary Analysis](https://www.amma2050.org/) (AMMA-2050) project.

Owner

GitHub Events