Skip to content

Documents · Verb reference

fire_panel

Return the fire analysis bundle plus figure objects for custom layouts.

Callable type: Visualization helper (direct call) · Browse: Visualization

Call this helper directly with the documented data arguments; it does not return a configured pipe stage. Use v.apply(...) or an explicit callable if composition is needed.

Usage

from cubedynamics import verbs as v
v.fire_panel(da=None, *, fired_event=None, fired_daily=None, event_id=None, climate_variable='vpd', freq=None, time_buffer_days=1, n_ring_samples=200, n_theta=296, bins=40, show_hist=True, verbose=False, **kwargs)

Arguments

Argument Meaning Default
da See implementation docstring below; no parameter-specific description supplied. None
fired_event See implementation docstring below; no parameter-specific description supplied. None
fired_daily See implementation docstring below; no parameter-specific description supplied. None
event_id See implementation docstring below; no parameter-specific description supplied. None
climate_variable See implementation docstring below; no parameter-specific description supplied. 'vpd'
freq See implementation docstring below; no parameter-specific description supplied. None
time_buffer_days See implementation docstring below; no parameter-specific description supplied. 1
n_ring_samples See implementation docstring below; no parameter-specific description supplied. 200
n_theta See implementation docstring below; no parameter-specific description supplied. 296
bins See implementation docstring below; no parameter-specific description supplied. 40
show_hist See implementation docstring below; no parameter-specific description supplied. True
verbose See implementation docstring below; no parameter-specific description supplied. False
kwargs See implementation docstring below; no parameter-specific description supplied. forwarded arguments

Accepts

FireEventDaily / FireHull or VaseDefinition geometry and/or an observed climate cube, as specified by the arguments. Match CRS and event dates before attribution.

Returns

The public docstring does not specify a return contract. Do not assume a pipe-ready return; consult the linked implementation.

Order / grammar behavior

Construct and validate event geometry before attributing climate or rendering. Fire plotting still uses a Plotly hull backend; it is not the general HTML cube viewer.

Minimal example

Follow the real FIRED event and streamed gridMET example. It provides the event acquisition, geometry, climate loading and plots together; a climate cube alone is insufficient for this operation.

Works with

FireEventDaily / FireHull or VaseDefinition geometry and/or an observed climate cube, as specified by the arguments. Match CRS and event dates before attribution.

See also

Implementation notes

No additional implementation notes in the current docstring.

Implementation source. Signatures and descriptions on this page are generated from this checkout, not hand-maintained copies.