Remove unused var_units argument from docstring

Author: leosaffin

docs/examples/ERA-20C_assessment.ipynb

@@ -5,7 +5,7 @@
    "id": "978b8621-e050-47c3-8e66-807cbac823e6",
    "metadata": {},
    "source": [
-    "# `huracanpy` basic use for assessing storm climatology in a dataset\n",
+    "# Assessing storm climatology in a dataset\n",
     "Here, we examplify usage of `huracanpy` with the dataset of TC in ERA-20C detected by the TRACK algorithm.\n",
     "This is meant to show an example of workflow. Please refer to specific parts of the documentation to learn about each part (e.g. loading, plotting, etc.) in more detail."
    ]
@@ -87,15 +87,16 @@
    "outputs": [],
    "source": [
     "# Apply add_all_info to add a number of useful attributes.\n",
-    "data = huracanpy.utils.add_all_info(\n",
+    "data = huracanpy.info.add_all_info(\n",
     "    data,\n",
     "    lat_name=\"latitude\",\n",
     "    lon_name=\"longitude\",\n",
-    "    wind_name=\"wind_speed_10m\",\n",
-    "    slp_name=\"psl\",\n",
-    "    slp_units=\"hPa\",\n",
     ")\n",
-    "# If you want to add individually the one you need instead, have a look at the functionning of the utils module itself."
+    "# If you want to add individually the one you need instead, have a look at the functionning of the info module itself.\n",
+    "\n",
+    "# TC specific\n",
+    "data[\"sshs\"] = huracanpy.tc.get_sshs_cat(data.wind_speed_10m)\n",
+    "data[\"pres_cat\"] = huracanpy.tc.get_sshs_cat(data.psl)"
    ]
   },
   {
@@ -172,7 +173,7 @@
    ],
    "source": [
     "# Basic plot of the data points\n",
-    "huracanpy.plot.tracks.plot_tracks_basic(\n",
+    "huracanpy.plot.tracks(\n",
     "    data.longitude,\n",
     "    data.latitude,\n",
     "    data.wind_speed_10m,\n",
@@ -575,7 +576,7 @@
    ],
    "source": [
     "# Frequency (Number of track per year)\n",
-    "huracanpy.diags.climato.freq(data, by=\"season\")"
+    "huracanpy.calc.freq(data, by=\"season\")"
    ]
   },
   {
@@ -965,7 +966,7 @@
    ],
    "source": [
     "# TCD (Accumulated duration of storms per year)\n",
-    "huracanpy.diags.climato.TC_days(data, by=\"season\")"
+    "huracanpy.calc.get_track_duration(data.time, data.track_ids).groupby(data.season).sum()"
    ]
   },
   {
@@ -1355,9 +1356,11 @@
    ],
    "source": [
     "# ACE (aggregated per year)\n",
-    "huracanpy.utils.ace.ace_by_point(\n",
-    "    data.wind_speed_10m, threshold=0, wind_units=\"m s**-1\"\n",
-    ").groupby(data.season).sum().mean()"
+    "huracanpy.tc.ace(\n",
+    "    data.wind_speed_10m,\n",
+    "    sum_by=data.time.dt.year,\n",
+    "    threshold=0,\n",
+    ").mean()"
    ]
   },
   {
@@ -1391,15 +1394,15 @@
     "\n",
     "fig, axs = plt.subplots(3, sharex=True)\n",
     "# Frequency\n",
-    "data.groupby(\"season\").apply(huracanpy.diags.climato.freq).plot(ax=axs[0])\n",
+    "data.groupby(\"season\").apply(huracanpy.calc.freq).plot(ax=axs[0])\n",
     "axs[0].set_ylabel(\"Number of tracks\")\n",
     "# TCD\n",
-    "data.groupby(\"season\").apply(huracanpy.diags.climato.TC_days).plot(ax=axs[1])\n",
+    "data.groupby(\"season\").apply(huracanpy.calc.duration).plot(ax=axs[1])\n",
     "axs[1].set_ylabel(\"TC days\")\n",
     "# ACE\n",
-    "data.groupby(\"season\").apply(\n",
-    "    lambda x: huracanpy.diags.climato.ACE(x, wind_name=\"wind_speed_10m\")\n",
-    ").plot(ax=axs[2])\n",
+    "data.groupby(\"season\").apply(lambda x: huracanpy.tc.ace(x.wind_speed_10m).sum()).plot(\n",
+    "    ax=axs[2]\n",
+    ")\n",
     "axs[2].set_ylabel(\"ACE\")\n",
     "\n",
     "for ax in axs:\n",
@@ -1437,7 +1440,7 @@
    "source": [
     "## Seasonal\n",
     "\n",
-    "gen = huracanpy.diags.track_stats.gen_vals(\n",
+    "gen = huracanpy.calc.gen_vals(\n",
     "    data,\n",
     ")  # Extract the point of genesis for each track\n",
     "(\n",
@@ -1491,10 +1494,10 @@
     "fig, axs = plt.subplots(1, 3, sharey=True, figsize=[15, 5])\n",
     "\n",
     "# Duration\n",
-    "huracanpy.diags.track_stats.duration(data.time, data.track_id).plot.hist(ax=axs[0])\n",
+    "huracanpy.calc.get_duration(data.time, data.track_id).plot.hist(ax=axs[0])\n",
     "\n",
     "# Maximum wind speed\n",
-    "huracanpy.diags.track_stats.extremum_vals(\n",
+    "huracanpy.calc.get_extremum_vals(\n",
     "    data, varname=\"wind_speed_10m\", stat=\"max\"\n",
     ").wind_speed_10m.plot.hist(ax=axs[1])\n",
     "\n",
@@ -1945,8 +1948,8 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (Spyder)",
-   "language": "python3",
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
    "name": "python3"
   },
   "language_info": {
@@ -1959,7 +1962,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.9"
+   "version": "3.12.4"
   }
  },
  "nbformat": 4,

huracanpy/calc/_rates.py

@@ -22,7 +22,6 @@ def get_delta(var, track_ids=None, centering="forward"):
     ----------
     var : xarray.DataArray
     track_ids : array_like, optional
-    var_units : str, optional
     centering : str, optional
 
     Returns