Skip to content

Commit a49c61f

Browse files
AtmaManirohitgeo
authored andcommitted
updated API overview to reflect 2 new modules (#235)
* updated API overview to reflect 2 new modules * grammar
1 parent 430ee48 commit a49c61f

File tree

2 files changed

+18
-12
lines changed

2 files changed

+18
-12
lines changed

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@
1919
"metadata": {},
2020
"source": [
2121
"## Architecture of the API\n",
22-
"The API is distributed as the `arcgis` conda package. Within the `arcgis` package, which represents the generic GIS model, functionality is organized into a number of different modules that makes it simple to use and understand. Each module has a handful of types and functions that are focused towards one aspect of the GIS.\n",
22+
"The API is distributed as the `arcgis` package via conda and pip. Within the `arcgis` package, which represents the generic GIS model, functionality is organized into a number of different modules that makes it simple to use and understand. Each module has a handful of types and functions that are focused towards one aspect of the GIS.\n",
2323
"\n",
24-
"This diagram below depicts the modules present in the API. \n",
24+
"This diagram below depicts the modules present in the API.\n",
2525
"\n",
26-
"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",
26+
"<img src=\"../../static/img/guide_api_overview_modules.png\" align=\"center\" width=\"500\">\n",
2727
"\n",
28-
"The modules in green are used to access the various spatial capabilities or geographic datasets in the GIS. These module includes a family of geoprocessing functions, types and other helper objects for working with spatial data of a particular type.\n",
28+
"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",
2929
"\n",
30-
"The modules in blue provide additional functionality for your workflows. They include the geocoding module which is for finding places, the geometry module for representing the geometries of feature data and functions for working with them, and the geoprocessing module that makes it easy to import third party geoprocessing tools and work with them.\n",
30+
"The modules in green are used to access the various spatial capabilities or geographic datasets in the GIS. These modules include a family of geoprocessing functions, types and other helper objects for working with spatial data of a particular type.\n",
3131
"\n",
32-
"The modules in orange allow you to visualize GIS data and analysis. This module includes the MapView Jupyter notebook widget for visualizing maps and layers and the mapping module has types and functions for working with web maps and web layers.\n",
32+
"The modules in blue provide additional functionality for your workflows. They include the `geocoding` module which is for finding places, the `geometry` module for representing the geometries of feature data and functions for working with them, the `geoprocessing` module that makes it easy to import third party geoprocessing tools and work with them and the `geoenrichment` module that helps you enrich your datasets with thematic information.\n",
3333
"\n",
34-
"![arcgis-api-modules](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_api_overview_01.png)\n",
34+
"The modules in orange allow you to visualize and disseminate your GIS data and analysis. The `widgets` module includes the MapView Jupyter notebook widget for visualizing maps and layers, the `mapping` module has types and functions for working with web maps and web layers and the `apps` module helps you create and manage web applications built with ArcGIS.\n",
3535
"\n",
3636
"### `arcgis.gis` module\n",
3737
"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",
@@ -60,6 +60,9 @@
6060
"### `arcgis.geometry` module\n",
6161
"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",
6262
"\n",
63+
"### `arcgis.geoenrichment` module\n",
64+
"The `arcgis.geoenrichment` module provides the ability to get facts about a location or area. Using GeoEnrichment, you can get information about the people and places in a specific area or within a certain distance or drive time from a location. You can use this data to enhance the accuracy of your predictive models or better explain the inferences you gain from them.\n",
65+
"\n",
6366
"### `arcgis.geoprocessing` module\n",
6467
"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",
6568
"\n",
@@ -70,7 +73,10 @@
7073
"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",
7174
"\n",
7275
"### `arcgis.widgets` module\n",
73-
"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"
76+
"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",
77+
"\n",
78+
"### `arcgis.apps` module\n",
79+
"The `arcgis.apps` module allows you to manage some of the web based applications available in ArcGIS."
7480
]
7581
},
7682
{
@@ -80,16 +86,16 @@
8086
"#### How this website is organized\n",
8187
"The **guide** pages explain each individual concept of the API and the best practices. The **sample notebooks** explain how to use the API to write Python scripts, incorporating capabilities such as mapping, query, analysis, geocoding, routing, portal administration, and more to solve real world problems. If you are looking for recipes, you may find them as sample notebooks. \n",
8288
"\n",
83-
"The **api reference** provides a reference for each class, its properties and methods in the `arcgis` package. The **forum** is a geonet community where you can share your thoughts about the API, request for features, conduct polls, report bugs, ask questions and engage with the Python community in general."
89+
"The **api reference** provides a reference for each class, its properties and methods in the `arcgis` package. The **community** is a geonet forum where you can share your thoughts about the API, request for features, conduct polls, report bugs, ask questions and engage with the Python community in general."
8490
]
8591
}
8692
],
8793
"metadata": {
8894
"anaconda-cloud": {},
8995
"kernelspec": {
90-
"display_name": "Python [geosaurus_gold]",
96+
"display_name": "Python 3",
9197
"language": "python",
92-
"name": "Python [geosaurus_gold]"
98+
"name": "python3"
9399
},
94100
"language_info": {
95101
"codemirror_mode": {
@@ -101,7 +107,7 @@
101107
"name": "python",
102108
"nbconvert_exporter": "python",
103109
"pygments_lexer": "ipython3",
104-
"version": "3.5.2"
110+
"version": "3.6.4"
105111
}
106112
},
107113
"nbformat": 4,
105 KB
Loading

0 commit comments

Comments
 (0)