events

• 1 events
  • 1.1 Functions

events

``

Functions

Name	Description
copy_event
create_historical_hurricane_event	Create a historical hurricane event object from a dictionary of attributes.
create_historical_nearshore_event	Create a historical nearshore event object from a dictionary of attributes.
create_historical_offshore_event	Create a historical offshore event object from a dictionary of attributes.
create_synthetic_event	Create a synthetic event object from a dictionary of attributes.
delete_event
download_wl_data
edit_event
get_event
get_event_mode
get_events
plot_rainfall
plot_river
plot_wind
plot_wl
read_csv
save_cyclone_track
save_event_toml
save_timeseries_csv

copy_event

copy_event(old_name, new_name, new_description)

create_historical_hurricane_event

create_historical_hurricane_event(attrs)

Create a historical hurricane event object from a dictionary of attributes.

Parameters

Name	Type	Description	Default
attrs	dict[str, Any]	Dictionary of attributes	required

Returns

Type	Description
HistoricalHurricane	Historical hurricane event object

create_historical_nearshore_event

create_historical_nearshore_event(attrs)

Create a historical nearshore event object from a dictionary of attributes.

Parameters

Name	Type	Description	Default
attrs	dict[str, Any]	Dictionary of attributes	required

Returns

Type	Description
HistoricalNearshore	Historical nearshore event object

create_historical_offshore_event

create_historical_offshore_event(attrs)

Create a historical offshore event object from a dictionary of attributes.

Parameters

Name	Type	Description	Default
attrs	dict[str, Any]	Dictionary of attributes	required

Returns

Type	Description
HistoricalNearshore	Historical offshore event object

create_synthetic_event

create_synthetic_event(attrs)

Create a synthetic event object from a dictionary of attributes.

Parameters

Name	Type	Description	Default
attrs	dict[str, Any]	Dictionary of attributes	required

Returns

Type	Description
Synthetic	Synthetic event object

delete_event

delete_event(name)

download_wl_data

download_wl_data(station_id, start_time, end_time, units, source, file=None)

edit_event

edit_event(event)

get_event

get_event(name)

get_event_mode

get_event_mode(name)

get_events

get_events()

plot_rainfall

plot_rainfall(event, input_rainfall_df=None)

plot_river

plot_river(event, input_river_df)

plot_wind

plot_wind(event, input_wind_df=None)

plot_wl

plot_wl(event, input_wl_df=None)

read_csv

read_csv(csvpath)

save_cyclone_track

save_cyclone_track(event, track)

save_event_toml

save_event_toml(event)

save_timeseries_csv

save_timeseries_csv(name, event, df)