hesmapy.hydro package¶
Submodules¶
hesmapy.hydro.hydro1d module¶
- class hesmapy.hydro.hydro1d.Hydro1D(path)¶
Bases:
HesmaBaseJSONFile- get_data(time: float = None, model: str | int = None) DataFrame¶
Get the data for a specific time step
Parameters¶
- timefloat, optional
Time step to get data for, by default None
- modelstr | int, optional
Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted
Returns¶
pd.DataFrame
- get_unique_times(model: str | int = None) list¶
Get the unique time steps for a model. Returns an empty list if the data is invalid
Parameters¶
- modelstr | int, optional
Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted
Returns¶
list
- get_units(model: str | int = None) dict¶
Get the units for a model
Parameters¶
- modelstr | int, optional
Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted
Returns¶
dict
- plot(model: str | int = None, show_plot: bool = False, max_abundances: int = 5) Figure¶
Plot the data
Parameters¶
- modelstr | int, optional
Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted
- show_plotbool, optional
Show the plot, by default False
- max_abundancesint, optional
Maximum number of abundances to plot, by default 5. Abundances will be plotted in order of decreasing abundance
Returns¶
go.Figure