Tropycal
A Python package intended to simplify the process of retrieving and analyzing tropical cyclone data, both for past storms and in real time.
https://github.com/tropycal/tropycal
Category: Climate Change
Sub Category: Natural Hazard and Storm
Last synced: about 19 hours ago
JSON representation
Repository metadata
- Host: GitHub
- URL: https://github.com/tropycal/tropycal
- Owner: tropycal
- License: mit
- Created: 2019-10-11T22:18:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T09:10:24.000Z (9 months ago)
- Last Synced: 2025-04-20T09:44:00.454Z (7 days ago)
- Language: Python
- Homepage: https://tropycal.github.io/tropycal/
- Size: 228 MB
- Stars: 155
- Watchers: 7
- Forks: 38
- Open Issues: 25
- Releases: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/support.rst
README.md
Tropycal
Tropycal is a Python package intended to simplify the process of retrieving and analyzing tropical cyclone data, both for past storms and in real time, and is geared towards the research and operational meteorology sectors.
Tropycal can read in HURDAT2 and IBTrACS reanalysis data and operational National Hurricane Center (NHC) Best Track data and conform them to the same format, which can be used to perform climatological, seasonal and individual storm analyses. For each individual storm, operational NHC and model forecasts, aircraft reconnaissance data, rainfall data, and any associated tornado activity can be retrieved and plotted.
The latest version of Tropycal is v1.3.
Installation
Conda
The currently recommended method of installation is via conda:
conda install -c conda-forge tropycal
Pip
Installation is also available via pip:
pip install tropycal
From source
Tropycal can also be installed from source by cloning the GitHub repository:
git clone https://github.com/tropycal/tropycal
cd tropycal
python setup.py install
Dependencies
- matplotlib >= 2.2.2
- numpy >= 1.14.3
- scipy >= 1.1.0
- pandas >= 1.3.0
- xarray >= 0.10.7
- networkx >= 2.0.0
- requests >= 2.22.0
- pyshp >= 2.1
To fully leverage tropycal's plotting capabilities, it is strongly recommended to have cartopy >= 0.17.0 installed.
Documentation
For full documentation and examples, please refer to Tropycal Documentation.
As of v0.3, the documentation is up-to-date following a bug that started with v0.2.5 where the documentation was not updated with each release.
Sample Usage
As an example, read in the North Atlantic HURDAT2 reanalysis dataset, excluding Best Track (current year's storms):
import tropycal.tracks as tracks
basin = tracks.TrackDataset(basin='north_atlantic')
Individual Storm Analysis
Individual storms can be retrieved from the dataset by calling the "get_storm" function, which returns an instance of a Storm object. This can be done by either entering a tuple containing the storm name and year, or by the standard tropical cyclone ID (e.g., AL012019).
Let's retrieve an instance of Hurricane Michael from 2018:
storm = basin.get_storm(('michael',2018))
This instance of Storm contains several methods that return the storm data back in different data types. The following examples will show how to retrieve 3 different data types.
Retrieve Michael's data in different data formats:
storm.to_dict()
storm.to_xarray()
storm.to_dataframe()
Visualize Michael's observed track with the plot
function:
Note that you can pass various arguments to the plot
function, such as customizing the map and track aspects. The only cartopy projection currently offered is PlateCarree. Read through the documentation for more customization options.
storm.plot()
If this storm was ever in NHC's area of responsibility, you can retrieve operational forecast data for this event provided it is available. Forecast discussions date back to 1992, and forecast tracks date back to 1950.
Retrieve a single forecast discussion for Michael - both of these methods will yield an identical result:
#Method 1: Specify date closest to desired discussion
disco = storm.get_nhc_discussion(forecast=dt.datetime(2018,10,7,0))
print(disco['text'])
#Method 2: Specify forecast discussion ID
disco = storm.get_nhc_discussion(forecast=2)
print(disco['text'])
NHC also archives forecast tracks, albeit in a different format than the official advisory data, so the operational forecast IDs here differ from the discussion IDs. As such, the forecast cone is not directly retrieved from NHC, but is generated using an algorithm that yields a cone closely resembling the official NHC cone.
Let's plot Michael's second forecast cone:
storm.plot_nhc_forecast(forecast=2)
Now let's look at the 12th forecast for Michael.
Note that the observed track here differs from the HURDAT2 track plotted previously! This is because this plot displays the operationally analyzed location and intensity, rather than the post-storm analysis data. This is done to account for differences between HURDAT2 and operational data.
storm.plot_nhc_forecast(forecast=12)
Owner metadata
- Name: TroPYcal
- Login: tropycal
- Email:
- Kind: user
- Description:
- Website: https://tropycal.readthedocs.io/en/latest/index.html
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/56456921?u=5384d33c04e4e444d15314f092214326f98dcd50&v=4
- Repositories: 1
- Last ynced at: 2023-03-03T02:30:38.505Z
- Profile URL: https://github.com/tropycal
GitHub Events
Total
- Issues event: 1
- Watch event: 16
- Fork event: 2
Last Year
- Issues event: 1
- Watch event: 16
- Fork event: 2
Committers metadata
Last synced: 5 days ago
Total Commits: 749
Total Committers: 13
Avg Commits per committer: 57.615
Development Distribution Score (DDS): 0.219
Commits in past year: 142
Committers in past year: 2
Avg Commits per committer in past year: 71.0
Development Distribution Score (DDS) in past year: 0.007
Name | Commits | |
---|---|---|
Tomer Burg | t****g@o****u | 585 |
tomerburg | t****g@a****u | 96 |
Sam Lillo | s****o@g****m | 42 |
Sam Lillo | 4****o | 9 |
Sam Lillo | S****o@d****m | 5 |
Tyler Mitchell | t****l@b****m | 3 |
Ray Bell | r****l@d****m | 2 |
tropycal | t****g@g****m | 2 |
Lisa L. Lowe | l****e@g****m | 1 |
Tomer Aberbach | t****h@g****m | 1 |
Tyler Mitchell | z****i@g****m | 1 |
CyanideCN | 4****N | 1 |
Ray Bell | r****0@g****m | 1 |
Committer domains:
- dtn.com: 2
- box.com: 1
- albany.edu: 1
- ou.edu: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 79
Total pull requests: 58
Average time to close issues: 6 months
Average time to close pull requests: 10 days
Total issue authors: 54
Total pull request authors: 8
Average comments per issue: 1.73
Average comments per pull request: 0.31
Merged pull request: 52
Bot issues: 0
Bot pull requests: 0
Past year issues: 12
Past year pull requests: 3
Past year average time to close issues: 7 days
Past year average time to close pull requests: 3 minutes
Past year issue authors: 10
Past year pull request authors: 3
Past year average comments per issue: 0.42
Past year average comments per pull request: 0.33
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- raybellwaves (4)
- srmullens (4)
- winash12 (3)
- ahuang11 (3)
- CongGao-CG (3)
- stucka (3)
- tropicalblog (2)
- kylejgillett (2)
- cybertosher (2)
- matthewcuyugan (2)
- wxguy (2)
- gameskip (2)
- elierpf (2)
- mguzelevich (2)
- cynthiazeng (2)
Top Pull Request Authors
- tomerburg (45)
- splillo (6)
- raybellwaves (2)
- mguzelevich (1)
- lisalenorelowe (1)
- ddxv (1)
- leosaffin (1)
- brianmapes (1)
Top Issue Labels
- bug (5)
Top Pull Request Labels
Package metadata
- Total packages: 2
-
Total downloads:
- pypi: 27,605 last-month
- Total dependent packages: 2 (may contain duplicates)
- Total dependent repositories: 26 (may contain duplicates)
- Total versions: 51
- Total maintainers: 1
pypi.org: tropycal
Package for retrieving and analyzing tropical cyclone data
- Homepage: https://github.com/tropycal/tropycal
- Documentation: https://tropycal.github.io/tropycal/
- Licenses: mit
- Latest release: 1.2.1 (published over 1 year ago)
- Last Synced: 2025-04-25T12:08:17.096Z (2 days ago)
- Versions: 33
- Dependent Packages: 1
- Dependent Repositories: 24
- Downloads: 27,605 Last month
-
Rankings:
- Dependent repos count: 2.983%
- Dependent packages count: 3.244%
- Average: 5.933%
- Stargazers count: 6.706%
- Forks count: 7.133%
- Downloads: 9.599%
- Maintainers (1)
conda-forge.org: tropycal
- Homepage: https://github.com/tropycal/tropycal
- Licenses: MIT
- Latest release: 0.5.2 (published over 2 years ago)
- Last Synced: 2025-04-02T02:57:42.846Z (25 days ago)
- Versions: 18
- Dependent Packages: 1
- Dependent Repositories: 2
-
Rankings:
- Dependent repos count: 20.06%
- Average: 28.745%
- Dependent packages count: 28.954%
- Forks count: 32.318%
- Stargazers count: 33.646%
Dependencies
- matplotlib >=2.2.2
- networkx *
- numpy >=1.14.3
- pandas >=0.23.0
- scipy >=1.1.0
Score: 17.98470838596836