Update pre-commit hooks and associated style changes

Author: trey-stafford

.pre-commit-config.yaml

@@ -27,14 +27,14 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v4.0.0-alpha.8"
+    rev: "v3.1.0"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
         args: [--prose-wrap=always]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.11.8"
+    rev: "v0.11.9"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]

CODE_OF_CONDUCT.md

@@ -2,7 +2,9 @@
 
 ## 1. Our Commitment
 
-We are dedicated to fostering a respectful environment for everyone contributing to this project. We expect all participants to treat each other with respect, professionalism, and kindness.
+We are dedicated to fostering a respectful environment for everyone contributing
+to this project. We expect all participants to treat each other with respect,
+professionalism, and kindness.
 
 ## 2. Expected Behavior
 
@@ -21,15 +23,20 @@ The following behaviors will not be tolerated:
 - Sharing inappropriate content.
 
 ## 4. Reporting Violations
-If you experience or witness any behavior that violates this Code of Conduct, please report it by contacting the project maintainers. All reports will be reviewed confidentially.
+
+If you experience or witness any behavior that violates this Code of Conduct,
+please report it by contacting the project maintainers. All reports will be
+reviewed confidentially.
 
 ## 5. Enforcement
-Violations of this Code of Conduct may result in actions such as warnings, temporary bans, or permanent exclusion from participation at the discretion of the maintainers.
+
+Violations of this Code of Conduct may result in actions such as warnings,
+temporary bans, or permanent exclusion from participation at the discretion of
+the maintainers.
 
 ## Contact Info
-Email: <[email protected]>
-Organization: National Snow and Ice Data Center¹
-Website: <https://nsidc.org/>
-Date last modified: 01-22-2025
+
+Email: <[email protected]> Organization: National Snow and Ice Data Center¹
+Website: <https://nsidc.org/> Date last modified: 01-22-2025
 
 ¹Work performed under NASA contract 80GSFC23CA035.

docs/iceflow-example.ipynb

@@ -33,21 +33,26 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
+    "import datetime as dt\n",
+    "from pathlib import Path\n",
+    "\n",
+    "import matplotlib.pyplot as plt\n",
+    "\n",
     "from nsidc.iceflow import (\n",
-    "    find_iceflow_data,\n",
-    "    download_iceflow_results,\n",
-    "    read_iceflow_datafiles,\n",
-    "    DatasetSearchParameters,\n",
     "    BoundingBox,\n",
+    "    DatasetSearchParameters,\n",
     "    ILATM1BDataset,\n",
+    "    download_iceflow_results,\n",
+    "    find_iceflow_data,\n",
+    "    read_iceflow_datafiles,\n",
     ")\n",
-    "from pathlib import Path\n",
-    "import datetime as dt\n",
-    "import matplotlib.pyplot as plt\n",
+    "\n",
     "# note: use `inline` to save the resulting image as an embedded png (nice for sharing). \\\n",
     "# Use `widget` to obtain interactive controls to explore the data in depth!\n",
     "%matplotlib inline\n",
-    "# %matplotlib widget\n"
+    "# %matplotlib widget"
    ]
   },
   {
@@ -73,8 +78,13 @@
     "# Define the dataset that we want to search for.\n",
     "atm1b_v1_dataset = ILATM1BDataset(version=\"1\")\n",
     "\n",
-    "# Define a bounding box for our area of interest. \n",
-    "BBOX = BoundingBox(lower_left_lon=-103.125559, lower_left_lat=-75.180563, upper_right_lon=-102.677327, upper_right_lat=-74.798063)\n",
+    "# Define a bounding box for our area of interest.\n",
+    "BBOX = BoundingBox(\n",
+    "    lower_left_lon=-103.125559,\n",
+    "    lower_left_lat=-75.180563,\n",
+    "    upper_right_lon=-102.677327,\n",
+    "    upper_right_lat=-74.798063,\n",
+    ")\n",
     "\n",
     "# We will define a short date range in 2009 to search for data.\n",
     "date_range = (dt.date(2009, 11, 1), dt.date(2009, 12, 31))"
@@ -202,7 +212,9 @@
    "outputs": [],
    "source": [
     "for variable in [\"latitude\", \"longitude\", \"elevation\"]:\n",
-    "    print(f\"Max difference in {variable}: {abs(itrf2014_df[variable] - iceflow_df[variable]).max()}\")"
+    "    print(\n",
+    "        f\"Max difference in {variable}: {abs(itrf2014_df[variable] - iceflow_df[variable]).max()}\"\n",
+    "    )"
    ]
   },
   {
@@ -257,7 +269,9 @@
    "outputs": [],
    "source": [
     "for variable in [\"latitude\", \"longitude\", \"elevation\"]:\n",
-    "    print(f\"Max difference in {variable}: {abs(itrf2014_epoch_2019_7_df[variable] - iceflow_df[variable]).max()}\")"
+    "    print(\n",
+    "        f\"Max difference in {variable}: {abs(itrf2014_epoch_2019_7_df[variable] - iceflow_df[variable]).max()}\"\n",
+    "    )"
    ]
   },
   {
@@ -277,7 +291,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "filter_condition = (iceflow_df.reset_index().index > 50) & ( iceflow_df.reset_index().index < 60)\n",
+    "filter_condition = (iceflow_df.reset_index().index > 50) & (\n",
+    "    iceflow_df.reset_index().index < 60\n",
+    ")\n",
     "sampled_iceflow_df = iceflow_df[filter_condition]\n",
     "sampled_itrf2014_df = itrf2014_df[filter_condition]\n",
     "sampled_itrf2014_epoch_2019_7_df = itrf2014_epoch_2019_7_df[filter_condition]"

docs/iceflow-with-icepyx.ipynb

@@ -49,8 +49,10 @@
    "outputs": [],
    "source": [
     "# Imports\n",
-    "from pathlib import Path\n",
+    "from __future__ import annotations\n",
+    "\n",
     "import datetime as dt\n",
+    "from pathlib import Path\n",
     "\n",
     "import dask.dataframe as dd\n",
     "import icepyx as ipx\n",
@@ -60,12 +62,12 @@
     "import xarray as xr\n",
     "\n",
     "from nsidc.iceflow import (\n",
-    "    make_iceflow_parquet,\n",
-    "    DatasetSearchParameters,\n",
     "    BoundingBox,\n",
-    "    find_iceflow_data,\n",
+    "    DatasetSearchParameters,\n",
+    "    IceflowDataFrame,\n",
     "    download_iceflow_results,\n",
-    "    IceflowDataFrame\n",
+    "    find_iceflow_data,\n",
+    "    make_iceflow_parquet,\n",
     ")"
    ]
   },
@@ -90,8 +92,8 @@
    "source": [
     "# Constants\n",
     "\n",
-    "# All of our data will be downloaded to this location. \n",
-    "OUTPUT_DIR =  Path(\"./downloaded-data/\")\n",
+    "# All of our data will be downloaded to this location.\n",
+    "OUTPUT_DIR = Path(\"./downloaded-data/\")\n",
     "\n",
     "# ICESat2 data products use ITRF2014 (e.g., see https://nsidc.org/data/atl06/versions/6):\n",
     "# > WGS 84 ellipsoid, ITRF2014 reference frame\n",
@@ -100,7 +102,12 @@
     "ICESAT2_ITRF = \"ITRF2014\"\n",
     "\n",
     "# This bounding box covers an area near Sermeq Kujalleq (Jakobshavn Isbrae)\n",
-    "BBOX = BoundingBox(lower_left_lon=-49.149, lower_left_lat=69.186, upper_right_lon=-48.949, upper_right_lat=69.238)\n",
+    "BBOX = BoundingBox(\n",
+    "    lower_left_lon=-49.149,\n",
+    "    lower_left_lat=69.186,\n",
+    "    upper_right_lon=-48.949,\n",
+    "    upper_right_lat=69.238,\n",
+    ")\n",
     "\n",
     "# Range of dates we want to evaluate\n",
     "DATE_RANGE = (dt.date(2007, 1, 1), dt.date(2024, 10, 28))"
@@ -195,7 +202,7 @@
    "source": [
     "iceflow_df = dd.read_parquet(parquet_path)\n",
     "\n",
-    "# Ensure that our index is set as a datetime object \n",
+    "# Ensure that our index is set as a datetime object\n",
     "iceflow_df = iceflow_df.reset_index()\n",
     "iceflow_df[\"utc_datetime\"] = dd.to_datetime(iceflow_df[\"utc_datetime\"])\n",
     "iceflow_df = iceflow_df.set_index(\"utc_datetime\")\n",
@@ -290,7 +297,7 @@
     "        reader.vars.append(var_list=[\"h_li\", \"latitude\", \"longitude\"])\n",
     "        ds = reader.load()\n",
     "        datasets.append(ds)\n",
-    "    except:\n",
+    "    except Exception:\n",
     "        print(f\"{file=} contains an error and will not be read\")\n",
     "        continue\n",
     "\n",
@@ -364,8 +371,8 @@
     "# Drop rows where lat, lon, or elev are missing.\n",
     "df = df.dropna(subset=[\"latitude\", \"longitude\", \"elevation\"], how=\"any\")\n",
     "df = df.set_index(\"utc_datetime\")\n",
-    "# Cast the df as an IceflowDataFrame. \n",
-    "# The `atl06_df` can now be used with e.g., `iceflow`'s ITRF conversion function \n",
+    "# Cast the df as an IceflowDataFrame.\n",
+    "# The `atl06_df` can now be used with e.g., `iceflow`'s ITRF conversion function\n",
     "# to perform plate motion model adjustments if desired.\n",
     "atl06_df = IceflowDataFrame(df)\n",
     "atl06_df.head()"
@@ -434,11 +441,13 @@
     "\n",
     "iceflow_df_sampled = iceflow_df_sampled[iceflow_df_sampled.elevation > 0]\n",
     "\n",
-    "iceflow_avg = iceflow_df_sampled.resample(\"W\").agg({\n",
-    "    \"elevation\": \"mean\",\n",
-    "    \"dataset\": lambda x: \", \".join(x.astype(\"str\").unique()),   \n",
-    "})\n",
-    "iceflow_avg = iceflow_avg.replace([np.inf, -np.inf], np.nan) \n",
+    "iceflow_avg = iceflow_df_sampled.resample(\"W\").agg(\n",
+    "    {\n",
+    "        \"elevation\": \"mean\",\n",
+    "        \"dataset\": lambda x: \", \".join(x.astype(\"str\").unique()),\n",
+    "    }\n",
+    ")\n",
+    "iceflow_avg = iceflow_avg.replace([np.inf, -np.inf], np.nan)\n",
     "iceflow_avg = iceflow_avg.dropna(how=\"any\")\n",
     "iceflow_avg = iceflow_avg.compute()\n",
     "\n",
@@ -479,9 +488,23 @@
     "for dataset, marker in iceflow_marker_map.items():\n",
     "    subset = iceflow_avg[iceflow_avg.dataset == dataset]\n",
     "    if subset.elevation.any():\n",
-    "        plt.scatter(subset.index, subset.elevation, marker=marker, label=dataset, linestyle=\"\", color=\"black\")\n",
+    "        plt.scatter(\n",
+    "            subset.index,\n",
+    "            subset.elevation,\n",
+    "            marker=marker,\n",
+    "            label=dataset,\n",
+    "            linestyle=\"\",\n",
+    "            color=\"black\",\n",
+    "        )\n",
     "\n",
-    "plt.scatter(atl06_avg_df.index, atl06_avg_df.elevation, color=\"black\", marker=\"*\", label=\"ATL06v6\", linestyle=\"\")\n",
+    "plt.scatter(\n",
+    "    atl06_avg_df.index,\n",
+    "    atl06_avg_df.elevation,\n",
+    "    color=\"black\",\n",
+    "    marker=\"*\",\n",
+    "    label=\"ATL06v6\",\n",
+    "    linestyle=\"\",\n",
+    ")\n",
     "\n",
     "plt.xlabel(\"Date\")\n",
     "plt.ylabel(\"Elevation\")\n",

notebooks/iceflow-example.ipynb

@@ -38,18 +38,18 @@
 
 
 __all__ = [
-    "__version__",
-    "make_iceflow_parquet",
-    "download_iceflow_results",
-    "find_iceflow_data",
-    "read_iceflow_datafiles",
-    "transform_itrf",
-    "DatasetSearchParameters",
-    "BoundingBox",
     "ALL_DATASETS",
     "BLATM1BDataset",
+    "BoundingBox",
+    "DatasetSearchParameters",
     "GLAH06Dataset",
     "ILATM1BDataset",
     "ILVIS2Dataset",
     "IceflowDataFrame",
+    "__version__",
+    "download_iceflow_results",
+    "find_iceflow_data",
+    "make_iceflow_parquet",
+    "read_iceflow_datafiles",
+    "transform_itrf",
 ]