Changelog#
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
v1.3.0#
Added#
Include missing accessor functions
get_beta_driftandadd_beta_driftplot_fancyline
plot.tracksandplot.densitycan be placed on existing axes if they are explicitly passed to the functionLoad tracks from the Imperial College Storm Model (IRIS)
huracanpy.infer_track_idto generate a track ID from unique combinations of variables. e.g. “year” and “storm number in year”.Also add as an option to
huracanpy.load
Can use
huracanpy.loadwith a list of fileshuracanpy.concat_tracksto concatenate tracks while keeping the track_id as a unique identifier
Changed#
Reduced unnecessary warning messages
Always use
var_nameas the accessor keyword for choosing a specific variable. Previously some functions usedvarnametrack density kde function integrates to the total number of points being passed, so that numbers are reasonable.
Fixed#
Consistent use of track_id in
deltacalculationsCorrectly convert units in
categoryfunctionsAlways do the
beta_driftcalculation with wind speed in metres per secondAllow requesting other time components than year/month/day/hour from
add_time_components, consistent withinfo.time_componentsget_azimuthwas calling the wrong functionCorrectly use wind in “knots” and pressure in “hPa” when using pre-calculated pressure-wind relations (“holland”, “z2021”) in
tc.paceUse a lower precision
datetime64when times are outside the default representable range
v1.2.0#
Added#
Modify
huracanpy.loadto load TRACK files with timesteps instead of dates (e.g.track_calendar=("1940-01-01", 6)to specify start time and timestep length in hours)Add “Old HURDAT”/ECMWF track data reader
Add function to compute azimuth
Allow
huracanpy.sel_idto be used to select multiple track IDs
Changed#
Update python versions supported (python 3.9-3.13, changed from 3.8-3.12)
v1.1.0#
Added#
Support for WiTRACK text files in huracanpy.load
Beta-drift computation (along with RMW support within distance function)
Full documentation incuding new examples
kde option for densities
Reference track set option for matching
Basin definitions from E. Sainsbury’s papers
Fixes#
Accessor was not behaving in the right way when the object was modified after the accessor’s first call;
Allow for ISO time to be called “isotime” in csv/parquet
v1.0.0#
Added#
xarray Dataset accessor (
hrcn)Extra keyword arguments to
huracanpy.loadrenameunitsbaselon
sel_idfunction to select a single track by track_id from aDatasetbut faster than usinggroupby
Changed#
Simplified module namespaces
utils.{module}.{function}->info.{function}diags.{module}.{function}->calc.{function}ortc.{function}subset.trackswhere->trackswhere
Simplified function naming
plot_prefix removed functions inplotmodule
Modified arguments to
loadkeyword
trackerrenamedsourceto reflect not all tracks are from trackers, e.g. IBTrACS or statistical-dynamical downscaling modelsUse
ibtracs_subsetto determine whether the subset is online or not, removingibtracs_onlinekeywordWhen
filenameis specified for an online IBTrACS dataset, save the downloaded data to that file, rather than usingibtracs_clean=Falseand a default filename
Use a single matching function
assess.matchfor 2 or more datasets instead ofassess.match_pairandassess.match_multipleRemove
get_from functions ininfo. Instead this syntax is used to differentiateget_andadd_functions in thehrcnaccessorSplit
info.get_land_or_oceanintois_landandis_oceanRenamed
tc.sshs_cattotc.saffir_simpson_categoryandtc.pres_cattotc.pressure_categoryImproved support for calculations with units (using metpy style functions)
Updated IBTrACS data
Removed#
add_infoargument fromhuracanpy.loadadd_all_infofunction. Instead useadd_functions onhrcnaccessorget_time. Functionality already covered bypandas.to_datetime
Fixed#
huracanpy.info.seasonnow works withcftime.datetime