Variables as an independent class (#451)

Refactor Variables class to be user facing functionality
icesat2py · Nov 15, 2023 · 142b7ab · 142b7ab
1 parent 9378cec
commit 142b7ab
Show file tree

Hide file tree

Showing 13 changed files with 880 additions and 461 deletions.
diff --git a/doc/source/example_notebooks/IS2_data_access2-subsetting.ipynb b/doc/source/example_notebooks/IS2_data_access2-subsetting.ipynb
@@ -51,7 +51,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "Create a query object and log in to Earthdata\n",
     "\n",
@@ -83,7 +85,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "## Discover Subsetting Options\n",
     "\n",
@@ -108,7 +112,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "By default, spatial and temporal subsetting based on your initial inputs is applied to your order unless you specify `subset=False` to `order_granules()` or `download_granules()` (which calls `order_granules` under the hood if you have not already placed your order) functions.\n",
     "Additional subsetting options must be specified as keyword arguments to the order/download functions.\n",
@@ -118,7 +124,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "### _Why do I have to provide spatial bounds to icepyx even if I don't use them to subset my data order?_\n",
     "\n",
@@ -132,7 +140,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "## About Data Variables in a query object\n",
     "\n",
@@ -145,7 +155,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "### Determine what variables are available for your data product\n",
     "There are multiple ways to get a complete list of available variables.\n",
@@ -159,23 +171,29 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "region_a.order_vars.avail()"
    ]
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "user_expressions": []
+   },
    "source": [
     "By passing the boolean `options=True` to the `avail` method, you can obtain lists of unique possible variable inputs (var_list inputs) and path subdirectory inputs (keyword_list and beam_list inputs) for your data product. These can be helpful for building your wanted variable list."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "region_a.order_vars.avail(options=True)"
@@ -353,9 +371,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "icepyx-dev",
    "language": "python",
-   "name": "python3"
+   "name": "icepyx-dev"
   },
   "language_info": {
    "codemirror_mode": {
@@ -367,7 +385,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,