docs/manual/gridtoolAppTutorial.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "55cfff46-7a1b-418e-a51f-a3a0988f63e0",
   "metadata": {},
   "source": [
    "# Gridtool Application Tutorial\n",
    "\n",
    "<div>\n",
    "    <img src=\"../images/gridNWAtl.png\" width=\"700\" height=\"500\">\n",
    "</div>\n",
    "\n",
    "**In this tutorial, we demonstrate how to create a Northwest Atlantic Grid.**\n",
    "<br>\n",
    "\n",
    "Once the Gridtool Python library is installed, we are able to use the GridTool Application to generate custom grids, visualize them, and save them as netCDF files. In this tutorial, we cover the basics of the application and demonstrate the generation of a Northwest Atlantic grid. If you haven't yet installed the Gridtools Python environment & libraries, [please follow this tutorial to install](https://github.com/ESMG/gridtools/blob/main/docs/manual/local_installation_tutorial.ipynb). \n",
    "\n",
    "***\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "179dcffe-a4f0-4ff8-81f1-a059c0f69642",
   "metadata": {},
   "source": [
    "# 1. Load the Gridtool Application\n",
    "\n",
    "<div>\n",
    "    <img src=\"../images/runMkGrid.png\" width=\"500\" height=\"500\">\n",
    "</div>\n",
    "\n",
    "<br>\n",
    "\n",
    "**1.1**\\. From your gridtools directory, open Jupyter Lab *or* Jupyter Notebook\n",
    "- `jupyter lab` or `jupyter notebook`\n",
    "**1.2**\\. Navigate to the `examples` folder, open `mkGridInteractive.ipynb` \\\n",
    "**1.3**\\. Run the notebook.\n",
    "\n",
    "<div>\n",
    "    <img src=\"../images/gridtoolApp.png\" width=\"500\" height=\"500\">\n",
    "</div>\n",
    "\n",
    "<br>\n",
    "<br>\n",
    "\n",
    "***"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "42e23181-1d04-4c0b-acd3-78122149aab3",
   "metadata": {},
   "source": [
    "# 2. Create the Grid\n",
    "\n",
    "<div>\n",
    "    <img src=\"../images/gridCenter.png\" width=\"500\" height=\"500\">\n",
    "</div>\n",
    "\n",
    "<br>\n",
    "\n",
    "**Let's create a grid located in the Northwest Atlantic and runs along the East Coast. Let's also give this grid a lambert conic conformal projection.**\n",
    "\n",
    "\n",
    "**2.1**\\. Navigate to the Grid Tab. \n",
    ">  *Notice that a user is automatically placed in the **Center** sub-tab of the parent Grid Tab*\n",
    "\n",
    "**2.2**\\.Specify a center longitude of **300 degrees**. \\\n",
    "**2.3**\\. Navigate to the **Projection** sub-tab. \\\n",
    "**2.4**\\. Set the **Projection** to **Lambert Conic Conformal**. \n",
    "> *This is the projection of the grid, NOT the projection of the visualized grid in the plot window*\n",
    "\n",
    "**2.5**\\. Specify a center longitude of **300 degrees** and a tilt of **-35 degrees**. \\\n",
    "**2.6**\\. Navigate to the **Spacing** sub-tab.\\\n",
    "**2.7**\\. Specify a **dx of 25** and a **dy of 35** \\\n",
    "**2.8**\\. Select the **Make Grid** button.\n",
    "\n",
    "\n",
    "<br>\n",
    "<br>\n",
    "\n",
    "***\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3c00fb82-063b-4e1f-a044-fbcad85c91eb",
   "metadata": {},
   "source": [
    "# 3. Plot the Grid\n",
    "\n",
    "<div>\n",
    "    <img src=\"../images/plotNWAtl.png\" width=\"700\" height=\"700\">\n",
    "</div>\n",
    "\n",
    "<br>\n",
    "\n",
    "**The plot projection only affects the projection of the image that visualizes the grid. When we made the grid above, a plot was automatically generated. However, the grid did not automatically fall within the default plot extent. First, we need to edit the plot extent.** \n",
    "\n",
    "\n",
    "\n",
    "**3.1**\\. Navigate to the Plot Tab. \n",
    ">  *Notice that a user is automatically placed in the **Projection** sub-tab of the parent Plot Tab*\n",
    "\n",
    "**3.2**\\. Specify a plot projection of **Lambert Conformal Conic** (or feel free to keep this as Nearside Perspective). \\\n",
    "> *This ONLY changes the projection of the **visualized** grid, NOT the projection of the grid itself.\n",
    "\n",
    "**3.3**\\. Specify a center longitude of **300 degrees**. \\\n",
    "**3.4**\\. Navigate to the Extent sub-tab. \\\n",
    "**3.5**\\. Specify a **Longitude(x0)** of **-100 degrees**, a **Longitude(x1)** of **-35 degrees**, a **Latitude(y0)** of **15 degrees** and a **Latitude(y1)** of **65 degrees**. \\\n",
    "**3.6**\\. Navigate to the Style sub-tab. \\\n",
    "**3.7**\\. Specify the Title to your choosing. \\\n",
    "**3.8**\\. Select the **Plot** button.\n",
    "\n",
    "<br>\n",
    "<br>\n",
    "\n",
    "***"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7e90a650-5bee-4b73-a91d-c31b5fce5dda",
   "metadata": {},
   "source": [
    "# 4. Download the Grid\n",
    "<div>\n",
    "    <img src=\"../images/gridInfo.png\" width=\"500\" height=\"500\">\n",
    "</div>\n",
    "\n",
    "<br>\n",
    "<br>\n",
    "\n",
    "**Once we are satisfied with the grid we've generated, we can proceed to download the Grid.**\n",
    "\n",
    "\n",
    "**4.1**\\. Navigate to the **Grid Info** window Tab. \\\n",
    "**4.2**\\. Double Check grid attributes (grid parameters, projection, extents, etc.). \n",
    "> Notice that the grid cell area and grid cell angles have been automatically computed based on our specifications to the grid above. \n",
    "\n",
    "**4.3**\\. Navigate to the **Local Files** window Tab. \\\n",
    "**4.4**\\. Name the **Grid filename** as you wish. \\\n",
    "**4.5**\\. Click the green **Download Grid** button. \n",
    "> The file will automatically be downloaded to the Downloads folder on your local machine.\n",
    "\n",
    "<br>\n",
    "<br>\n",
    "\n",
    "<div>\n",
    "    <img src=\"../images/downloadGrid.png\" width=\"500\" height=\"500\">\n",
    "</div>\n",
    "\n",
    "***"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "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.7.10"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}