Add additional usage examples and update a thumbnail (#181)

* new thumbnail for plot_contour_labels

* add usage examples and thumbnails

* oops add to examples.rst as well

* update release notes

docs/examples.rst

@@ -22,6 +22,8 @@ Here are some examples of how to use geocat-viz.
    examples/add_lat_lon_gridlines.ipynb
    examples/add_lat_lon_ticklabels.ipynb
    examples/set_tick_direction_spine_visibility.ipynb
+   examples/set_titles_and_labels.ipynb
+   examples/set_axes_limits_and_ticks.ipynb
    examples/add_right_hand_axis.ipynb
    examples/add_major_minor_ticks.ipynb
    examples/find_local_extrema.ipynb

docs/examples/set_axes_limits_and_ticks.ipynb

@@ -0,0 +1,87 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# `set_axes_limits_and_ticks`\n",
+    "\n",
+    "This notebook is a simple example of the GeoCAT-viz function <a href=\"../user_api/generated/geocat.viz.util.set_axes_limits_and_ticks.html#geocat-viz.util.set_axes_limits_and_ticks\">set_axes_limits_and_ticks</a>."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import packages:\n",
+    "\n",
+    "import numpy as np\n",
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "import geocat.viz as gv"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Generate example data:\n",
+    "\n",
+    "npts = 500\n",
+    "\n",
+    "x = 500 + 0.9 * np.arange(0, npts) * np.cos(np.pi / 100 * np.arange(0, npts))\n",
+    "y = 500 + 0.9 * np.arange(0, npts) * np.sin(np.pi / 100 * np.arange(0, npts))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Create plot\n",
+    "\n",
+    "# Create a figure\n",
+    "fig, ax = plt.subplots()\n",
+    "\n",
+    "# Plot the example data\n",
+    "ax.plot(x, y)\n",
+    "\n",
+    "# Use geocat.viz.util convenience function to set axes limits and tick labels\n",
+    "gv.set_axes_limits_and_ticks(ax,\n",
+    "                             xlim=(0, 900),\n",
+    "                             ylim=(100, 1000),\n",
+    "                             xticks=range(0, 901, 100),\n",
+    "                             yticks=range(100, 1001, 100))\n",
+    "\n",
+    "# Show the plot\n",
+    "plt.show();"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

docs/examples/set_titles_and_labels.ipynb

@@ -0,0 +1,88 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# `set_titles_and_labels`\n",
+    "\n",
+    "This notebook is a simple example of the GeoCAT-viz function <a href=\"../user_api/generated/geocat.viz.util.set_titles_and_labels.html#geocat-viz.util.set_titles_and_labels\">set_titles_and_labels</a>."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import packages:\n",
+    "\n",
+    "import numpy as np\n",
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "import geocat.viz as gv"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Generate example data:\n",
+    "\n",
+    "npts = 500\n",
+    "\n",
+    "x = 500 + 0.9 * np.arange(0, npts) * np.cos(np.pi / 100 * np.arange(0, npts))\n",
+    "y = 500 + 0.9 * np.arange(0, npts) * np.sin(np.pi / 100 * np.arange(0, npts))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Create plot\n",
+    "\n",
+    "# Create a figure\n",
+    "fig, ax = plt.subplots()\n",
+    "\n",
+    "# Plot the example data\n",
+    "ax.plot(x, y)\n",
+    "\n",
+    "# Use geocat.viz.util convenience function to set titles and labels\n",
+    "gv.set_titles_and_labels(ax,\n",
+    "                         maintitle=\"Title\",\n",
+    "                         maintitlefontsize=24,\n",
+    "                         xlabel=\"x\",\n",
+    "                         ylabel=\"y\",\n",
+    "                         labelfontsize=16)\n",
+    "\n",
+    "# Show the plot\n",
+    "plt.show();"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

docs/gallery.yml

@@ -33,3 +33,11 @@
 - title: 'plot_extrema_labels'
   path: examples/plot_extrema_labels.ipynb
   thumbnail: _static/thumbnails/plot_extrema_labels.png
+
+- title: 'set_titles_and_labels'
+  path: examples/set_titles_and_labels.ipynb
+  thumbnail: _static/thumbnails/set_titles_and_labels.png
+
+- title: 'set_axes_limits_and_ticks'
+  path: examples/set_axes_limits_and_ticks.ipynb
+  thumbnail: _static/thumbnails/set_axes_limits_and_ticks.png

docs/release-notes.rst

@@ -7,11 +7,12 @@ Release Notes
 
 v2023.11.0 (Unreleased)
 -----------------------
-[Plain text summary here]
+
 
 Documentation
 ^^^^^^^^^^^^^
-* Invert y-axis in add_height_from_pressure_axis example by `Katelyn FitzGerald`_ in (:pr:`173`)
+* Invert y-axis in ``add_height_from_pressure_axis`` example by `Katelyn FitzGerald`_ in (:pr:`173`)
+* Additions to the examples gallery for ``set_titles_and_labels`` and ``set_axes_limits_and_ticks`` and updated thumbnail for ``plot_contour_labels`` by `Katelyn FitzGerald`_ in (:pr:`181`)
 
 Bug Fixes
 ^^^^^^^^^