Merge pull request #1543 from jyaistMap/jy-upd-overview

Update the overview graphic and module descriptions as of 5/2023

Author: jyaistMap

guide/02-api-overview/overview-of-the-arcgis-api-for-python.ipynb

@@ -14,7 +14,7 @@
    },
    "source": [
     "<h1>Table of Contents<span class=\"tocSkip\"></span></h1>\n",
-    "<div class=\"toc\"><ul class=\"toc-item\"><li><span><a href=\"#Overview-of-the-ArcGIS-API-for-Python\" data-toc-modified-id=\"Overview-of-the-ArcGIS-API-for-Python-1\"><span class=\"toc-item-num\">1&nbsp;&nbsp;</span>Overview of the ArcGIS API for Python</a></span><ul class=\"toc-item\"><li><span><a href=\"#A-Pythonic-GIS-API\" data-toc-modified-id=\"A-Pythonic-GIS-API-1.1\"><span class=\"toc-item-num\">1.1&nbsp;&nbsp;</span>A Pythonic GIS API</a></span></li><li><span><a href=\"#Architecture-of-the-API\" data-toc-modified-id=\"Architecture-of-the-API-1.2\"><span class=\"toc-item-num\">1.2&nbsp;&nbsp;</span>Architecture of the API</a></span><ul class=\"toc-item\"><li><span><a href=\"#arcgis.gis-module\" data-toc-modified-id=\"arcgis.gis-module-1.2.1\"><span class=\"toc-item-num\">1.2.1&nbsp;&nbsp;</span><code>arcgis.gis</code> module</a></span></li><li><span><a href=\"#arcgis.env-module\" data-toc-modified-id=\"arcgis.env-module-1.2.2\"><span class=\"toc-item-num\">1.2.2&nbsp;&nbsp;</span><code>arcgis.env</code> module</a></span></li><li><span><a href=\"#arcgis.features-module\" data-toc-modified-id=\"arcgis.features-module-1.2.3\"><span class=\"toc-item-num\">1.2.3&nbsp;&nbsp;</span><code>arcgis.features</code> module</a></span></li><li><span><a href=\"#arcgis.raster-module\" data-toc-modified-id=\"arcgis.raster-module-1.2.4\"><span class=\"toc-item-num\">1.2.4&nbsp;&nbsp;</span><code>arcgis.raster</code> module</a></span></li><li><span><a href=\"#arcgis.network-module\" data-toc-modified-id=\"arcgis.network-module-1.2.5\"><span class=\"toc-item-num\">1.2.5&nbsp;&nbsp;</span><code>arcgis.network</code> module</a></span></li><li><span><a href=\"#arcgis.schematics-module\" data-toc-modified-id=\"arcgis.schematics-module-1.2.6\"><span class=\"toc-item-num\">1.2.6&nbsp;&nbsp;</span><code>arcgis.schematics</code> module</a></span></li><li><span><a href=\"#arcgis.geoanalytics-module\" data-toc-modified-id=\"arcgis.geoanalytics-module-1.2.7\"><span class=\"toc-item-num\">1.2.7&nbsp;&nbsp;</span><code>arcgis.geoanalytics</code> module</a></span></li><li><span><a href=\"#arcgis.geocoding-module\" data-toc-modified-id=\"arcgis.geocoding-module-1.2.8\"><span class=\"toc-item-num\">1.2.8&nbsp;&nbsp;</span><code>arcgis.geocoding</code> module</a></span></li><li><span><a href=\"#arcgis.geometry-module\" data-toc-modified-id=\"arcgis.geometry-module-1.2.9\"><span class=\"toc-item-num\">1.2.9&nbsp;&nbsp;</span><code>arcgis.geometry</code> module</a></span></li><li><span><a href=\"#arcgis.geoenrichment-module\" data-toc-modified-id=\"arcgis.geoenrichment-module-1.2.10\"><span class=\"toc-item-num\">1.2.10&nbsp;&nbsp;</span><code>arcgis.geoenrichment</code> module</a></span></li><li><span><a href=\"#arcgis.geoprocessing-module\" data-toc-modified-id=\"arcgis.geoprocessing-module-1.2.11\"><span class=\"toc-item-num\">1.2.11&nbsp;&nbsp;</span><code>arcgis.geoprocessing</code> module</a></span></li><li><span><a href=\"#arcgis.realtime-module\" data-toc-modified-id=\"arcgis.realtime-module-1.2.12\"><span class=\"toc-item-num\">1.2.12&nbsp;&nbsp;</span><code>arcgis.realtime</code> module</a></span></li><li><span><a href=\"#arcgis.mapping-module\" data-toc-modified-id=\"arcgis.mapping-module-1.2.13\"><span class=\"toc-item-num\">1.2.13&nbsp;&nbsp;</span><code>arcgis.mapping</code> module</a></span></li><li><span><a href=\"#arcgis.widgets-module\" data-toc-modified-id=\"arcgis.widgets-module-1.2.14\"><span class=\"toc-item-num\">1.2.14&nbsp;&nbsp;</span><code>arcgis.widgets</code> module</a></span></li><li><span><a href=\"#arcgis.apps-module\" data-toc-modified-id=\"arcgis.apps-module-1.2.15\"><span class=\"toc-item-num\">1.2.15&nbsp;&nbsp;</span><code>arcgis.apps</code> module</a></span><ul class=\"toc-item\"><li><span><a href=\"#How-this-website-is-organized\" data-toc-modified-id=\"How-this-website-is-organized-1.2.15.1\"><span class=\"toc-item-num\">1.2.15.1&nbsp;&nbsp;</span>How this website is organized</a></span></li></ul></li></ul></li></ul></li></ul></div>"
+    "<div class=\"toc\"><ul class=\"toc-item\"><li><span><a href=\"#Overview-of-the-ArcGIS-API-for-Python\" data-toc-modified-id=\"Overview-of-the-ArcGIS-API-for-Python-1\"><span class=\"toc-item-num\">1&nbsp;&nbsp;</span>Overview of the ArcGIS API for Python</a></span><ul class=\"toc-item\"><li><span><a href=\"#A-Pythonic-GIS-API\" data-toc-modified-id=\"A-Pythonic-GIS-API-1.1\"><span class=\"toc-item-num\">1.1&nbsp;&nbsp;</span>A Pythonic GIS API</a></span></li><li><span><a href=\"#Architecture-of-the-API\" data-toc-modified-id=\"Architecture-of-the-API-1.2\"><span class=\"toc-item-num\">1.2&nbsp;&nbsp;</span>Architecture of the API</a></span><ul class=\"toc-item\"><li><span><a href=\"#arcgis.gis-module\" data-toc-modified-id=\"arcgis.gis-module-1.2.1\"><span class=\"toc-item-num\">1.2.1&nbsp;&nbsp;</span><code>arcgis.gis</code> module</a></span></li><li><span><a href=\"#arcgis.env-module\" data-toc-modified-id=\"arcgis.env-module-1.2.2\"><span class=\"toc-item-num\">1.2.2&nbsp;&nbsp;</span><code>arcgis.env</code> module</a></span></li><li><span><a href=\"#arcgis.features-module\" data-toc-modified-id=\"arcgis.features-module-1.2.3\"><span class=\"toc-item-num\">1.2.3&nbsp;&nbsp;</span><code>arcgis.features</code> module</a></span></li><li><span><a href=\"#arcgis.raster-module\" data-toc-modified-id=\"arcgis.raster-module-1.2.4\"><span class=\"toc-item-num\">1.2.4&nbsp;&nbsp;</span><code>arcgis.raster</code> module</a></span></li><li><span><a href=\"#arcgis.network-module\" data-toc-modified-id=\"arcgis.network-module-1.2.5\"><span class=\"toc-item-num\">1.2.5&nbsp;&nbsp;</span><code>arcgis.network</code> module</a></span></li><li><span><a href=\"#arcgis.schematics-module\" data-toc-modified-id=\"arcgis.schematics-module-1.2.6\"><span class=\"toc-item-num\">1.2.6&nbsp;&nbsp;</span><code>arcgis.schematics</code> module</a></span></li><li><span><a href=\"#arcgis.geoanalytics-module\" data-toc-modified-id=\"arcgis.geoanalytics-module-1.2.7\"><span class=\"toc-item-num\">1.2.7&nbsp;&nbsp;</span><code>arcgis.geoanalytics</code> module</a></span></li><li><span><a href=\"#arcgis.geocoding-module\" data-toc-modified-id=\"arcgis.geocoding-module-1.2.8\"><span class=\"toc-item-num\">1.2.8&nbsp;&nbsp;</span><code>arcgis.geocoding</code> module</a></span></li><li><span><a href=\"#arcgis.geometry-module\" data-toc-modified-id=\"arcgis.geometry-module-1.2.9\"><span class=\"toc-item-num\">1.2.9&nbsp;&nbsp;</span><code>arcgis.geometry</code> module</a></span></li><li><span><a href=\"#arcgis.geoenrichment-module\" data-toc-modified-id=\"arcgis.geoenrichment-module-1.2.10\"><span class=\"toc-item-num\">1.2.10&nbsp;&nbsp;</span><code>arcgis.geoenrichment</code> module</a></span></li><li><span><a href=\"#arcgis.geoprocessing-module\" data-toc-modified-id=\"arcgis.geoprocessing-module-1.2.11\"><span class=\"toc-item-num\">1.2.11&nbsp;&nbsp;</span><code>arcgis.geoprocessing</code> module</a></span></li><li><span><a href=\"#arcgis.graph-module\" data-toc-modified-id=\"arcgis.graph-module-1.2.12\"><span class=\"toc-item-num\">1.2.12&nbsp;&nbsp;</span><code>arcgis.graph</code> module</a></span></li><li><span><a href=\"#arcgis.realtime-module\" data-toc-modified-id=\"arcgis.realtime-module-1.2.13\"><span class=\"toc-item-num\">1.2.13&nbsp;&nbsp;</span><code>arcgis.realtime</code> module</a></span></li><li><span><a href=\"#arcgis.mapping-module\" data-toc-modified-id=\"arcgis.mapping-module-1.2.14\"><span class=\"toc-item-num\">1.2.14&nbsp;&nbsp;</span><code>arcgis.mapping</code> module</a></span></li><li><span><a href=\"#arcgis.widgets-module\" data-toc-modified-id=\"arcgis.widgets-module-1.2.15\"><span class=\"toc-item-num\">1.2.15&nbsp;&nbsp;</span><code>arcgis.widgets</code> module</a></span></li><li><span><a href=\"#arcgis.apps-module\" data-toc-modified-id=\"arcgis.apps-module-1.2.16\"><span class=\"toc-item-num\">1.2.16&nbsp;&nbsp;</span><code>arcgis.apps</code> module</a></span><li><span><a href=\"#arcgis.auth-module\" data-toc-modified-id=\"arcgis.auth-module-1.2.17\"><span class=\"toc-item-num\">1.2.17&nbsp;&nbsp;</span><code>arcgis.auth</code> module</a></span><ul class=\"toc-item\"><li><span><a href=\"#How-this-website-is-organized\" data-toc-modified-id=\"How-this-website-is-organized-1.2.15.1\"><span class=\"toc-item-num\">1.2.15.1&nbsp;&nbsp;</span>How this website is organized</a></span></li></ul></li></ul></li></ul></li></ul></div>"
    ]
   },
   {
@@ -38,7 +38,7 @@
     "\n",
     "This diagram below depicts the modules present in the API.\n",
     "\n",
-    "<img src=\"../../static/img/guide_api_overview_modules.png\" align=\"center\" width=\"500\">\n",
+    "<img src=\"../../static/img/guide_api_modules_overview.png\" align=\"center\" width=\"1200\">\n",
     "\n",
     "The `gis` module is the most important and provides the entry point into the GIS. It lets you manage users, groups and content in the GIS. GIS admins spend a lot of time on this module.\n",
     "\n",
@@ -51,26 +51,38 @@
     "### `arcgis.gis` module\n",
     "The `arcgis.gis` module provides an information model for GIS hosted within ArcGIS Online or Portal for ArcGIS. This module provides functionality to manage (create, read, update and delete) GIS users, groups and content. This module is the most important and provides the entry point into the GIS. \n",
     "\n",
+    "#### `arcgis.gis` submodules\n",
+    "These submodules assist in various administrative level operations on server and server extension components of a Web GIS deployment. It also contains modules for working with auxiliary functionality such as the specific deployments for ArcGIS Notebooks and various sharing aspects to a Web GIS.\n",
+    "\n",
     "### `arcgis.env` module\n",
     "The `arcgis.env` module provides a shared environment used by the different modules. It stores globals such as the currently active GIS as well as environment settings that are common among all geoprocessing tools, such as the output spatial reference.\n",
     "\n",
     "### `arcgis.features` module\n",
-    "Entities located in space with a geometrical representation (such as points, lines or polygons) and a set of properties can be represented as features. The `arcgis.features` module is used for working with feature data, feature layers and collections of feature layers in the GIS. It also contains the spatial analysis functions which operate against feature data. \n",
+    "Entities located in space with a geometrical representation (such as points, lines or polygons) and a set of properties can be represented as features. The `arcgis.features` module is used for working with feature data, feature layers and collections of feature layers in the GIS.  It also contains the Spatially Enabled DataFrame ([SeDF](https://developers.arcgis.com/python/api-reference/arcgis.features.toc.html#geoaccessor)) which extends the popular Pandas DataFrame to work directly with spatial data. \n",
+    "\n",
+    "#### `arcgis.features` submodules\n",
+    "Several submodules contain spatial analysis functions which operate against feature data. The [managers](python/api-reference/arcgis.features.managers.html) submodule includes classes for administering the definition level functionality of [Feature Layers](/python/api-reference/arcgis.features.managers.html#featurelayermanager), as well as specialized classes for managing [Synchronization](/python/api-reference/arcgis.features.managers.html#syncmanager), [Versions](/python/api-reference/arcgis.features.managers.html#versionmanager) and service [Webhooks](/python/api-reference/arcgis.features.managers.html#webhookservicemanager). \n",
     "\n",
     "### `arcgis.raster` module\n",
     "Raster data is made up of a grid of cells, where each cell or pixel can have a value. Raster data is useful for storing data that varies continuously, as in a satellite image, a surface of chemical concentrations, or an elevation surface. The `arcgis.raster` module contains classes and raster analysis functions for working with raster data and imagery layers. \n",
     "\n",
+    "#### `arcgis.raster` submodules\n",
+    "These submodules contain many [analytical functions](/python/api-reference/arcgis.raster.analytics.html) to work with imagery services. It includes a module for the [Raster Function Template](/python/api-reference/arcgis.raster.functions.RFT.html) and [orthomapping](/python/api-reference/arcgis.raster.orthomapping.html) functionality.\n",
+    "\n",
     "### `arcgis.network` module\n",
     "The `arcgis.network` module contains classes and functions for network analysis. Network layers and analysis can be used for operations such as finding the closest facility, the best route for a vehicle, the best routes for a fleet of vehicles, locating facilities using location allocation, calculating an OD cost matrix, and generating service areas. \n",
     "\n",
+    "### `arcgis.notebook` module\n",
+    "The `arcgis.notebook` module serves to provide support functions for managing ArcGIS Notebooks that operate identically regardless of the Web GIS deployment type. These operations aid in snapshots and execution functionality.\n",
+    "\n",
     "### `arcgis.schematics` module\n",
     "Schematics are simplified representations of networks, intended to explain their structure and make the way they operate understandable. The `arcgis.schematics` module contains the types and functions for working with schematic layers and datasets. \n",
     "\n",
     "### `arcgis.geoanalytics` module\n",
     "The `arcgis.geoanalytics` module provides types and functions for distributed analysis of large feature and tabular datasets. These GeoAnalytics tools work with big data registered in the GIS’s datastores as well as with feature layers. \n",
     "\n",
     "### `arcgis.geocoding` module\n",
-    "The `arcgis.geocoding` provides classes and functions for geocoding, batch geocoding and reverse geocoding. Geocoders can find point locations of addresses, business names, and so on. The output points can be visualized on a map, inserted as stops for a route, or loaded as input for spatial analysis.\n",
+    "The `arcgis.geocoding` module provides classes and functions for geocoding, batch geocoding and reverse geocoding. Geocoders can find point locations of addresses, business names, and so on. The output points can be visualized on a map, inserted as stops for a route, or loaded as input for spatial analysis.\n",
     "\n",
     "### `arcgis.geometry` module\n",
     "The `arcgis.geometry` module defines useful geometry types for working with geographic information and GIS functionality. It provides functions which use geometric types as input and output as well as functions for easily converting geometries between different representations.\n",
@@ -81,17 +93,23 @@
     "### `arcgis.geoprocessing` module\n",
     "Users can create and share geoprocessing tools in the GIS. The `arcgis.geoprocessing` module provides helper types with dynamically created methods to invoke these tools, and provides simple types that can be used as parameters for these tools along with native Python types.\n",
     "\n",
+    "### `arcgis.graph` module\n",
+    "The `arcgis.graph` module contains classes and functions for working with the entities and relationships of an ArcGIS Knowledge graph. The available functions allow for searching and querying the graph data, and viewing the data model of the graph database.\n",
+    "\n",
     "### `arcgis.realtime` module\n",
     "The `arcgis.realtime` module provides types and functions for receiving real-time data feeds and sensor data streamed from the GIS to perform continuous processing and analysis. It includes support for stream layers that allow Python scripts to subscribe to the streamed feature data or broadcast updates or alerts.\n",
     "\n",
     "### `arcgis.mapping` module\n",
-    "The `arcgis.mapping` module provides components for visualizing GIS data and analysis. This module includes WebMap and WebScene components that enable 2D and 3D mapping and visualization in the GIS. This module also includes mapping layers like MapImageLayer and VectorTileLayer\n",
+    "The `arcgis.mapping` module provides components for visualizing GIS data and analysis. This module includes WebMap and WebScene components that enable 2D and 3D mapping and visualization in the GIS. This module includes layers like MapImageLayer and VectorTileLayer, as well as an [ogc](/python/api-reference/arcgis.mapping.toc.html#arcgis-mapping-ogc) submodule for working with OGC services. \n",
     "\n",
     "### `arcgis.widgets` module\n",
     "The `arcgis.widgets` module provides components for visualizing GIS data and analysis. This module includes the MapView Jupyter notebook widget for visualizing maps and layers\n",
     "\n",
     "### `arcgis.apps` module\n",
-    "The `arcgis.apps` module allows you to manage some of the web based applications available in ArcGIS."
+    "The `arcgis.apps` module allows you to manage some of the web based applications available in ArcGIS.\n",
+    "\n",
+    "### `arcgis.auth` module\n",
+    "The `arcgis.auth` module provides access to custom `requests` authentication handlers classes used for logging into the ArcGIS Web GIS systems. Users can customize and/or use these classes for their own python applications. "
    ]
   },
   {
@@ -122,7 +140,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.10"
+   "version": "3.9.16"
   },
   "toc": {
    "base_numbering": 1,