Skip to content

Commit d7e1133

Browse files
author
Atma Mani
authored
Merge pull request #879 from Esri/atmamani/update-install-doc-min-deps
adds ujson to min deps, other install doc fixes
2 parents 4915223 + d8e80b6 commit d7e1133

File tree

2 files changed

+112
-60
lines changed

2 files changed

+112
-60
lines changed

‎guide/01-getting-started/install-and-set-up.ipynb

Lines changed: 87 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,12 @@
1717
},
1818
{
1919
"cell_type": "markdown",
20-
"metadata": {},
20+
"metadata": {
21+
"toc": true
22+
},
2123
"source": [
22-
"- [Install the arcgis package](#Install-the-arcgis-package)\n",
23-
" - [Installation for ArcGIS Pro 2.5.x and later](#Installation-for-ArcGIS-Pro-2.5.x-and-later)\n",
24-
" - [Installation using Python Package Manager](#Installation-using-Python-Package-Manager)\n",
25-
" - [Installation using Python Command Prompt](#Installation-using-Python-Command-Prompt)\n",
26-
" - [Upgrade package](#Upgrade-package)\n",
27-
" - [Installation using Anaconda for Python Distribution](#Installation-using-Anaconda-for-Python-Distribution)\n",
28-
" - [Installation as a Docker image](#Installation-as-a-Docker-image)\n",
29-
" - [Install Offline](#Install-Offline)\n",
30-
" - [Installation for older versions](#Installation-for-older-versions)\n",
31-
"- [Install deep learning dependencies](#Install-deep-learning-dependencies) \n",
32-
" - [Using the Deep Learning Frameworks Installer](#Using-the-Deep-Learning-Frameworks-Installer)\n",
33-
" - [Using Python Command Prompt or Anaconda](#Using-Python-Command-Prompt-or-Anaconda)\n",
34-
"- [Test your install with jupyter notebook](#Test-your-install-with-jupyter-notebook)"
24+
"<h1>Table of Contents<span class=\"tocSkip\"></span></h1>\n",
25+
"<div class=\"toc\"><ul class=\"toc-item\"><li><span><a href=\"#Installation-for-ArcGIS-Pro-2.5.x-and-later\" data-toc-modified-id=\"Installation-for-ArcGIS-Pro-2.5.x-and-later-1\">Installation for ArcGIS Pro 2.5.x and later</a></span><ul class=\"toc-item\"><li><span><a href=\"#Installation-using-Python-Package-Manager\" data-toc-modified-id=\"Installation-using-Python-Package-Manager-1.1\">Installation using Python Package Manager</a></span></li><li><span><a href=\"#Installation-using-Python-Command-Prompt\" data-toc-modified-id=\"Installation-using-Python-Command-Prompt-1.2\">Installation using Python Command Prompt</a></span></li><li><span><a href=\"#Upgrade-package\" data-toc-modified-id=\"Upgrade-package-1.3\">Upgrade package</a></span></li></ul></li><li><span><a href=\"#Installation-using-Anaconda-for-Python-Distribution\" data-toc-modified-id=\"Installation-using-Anaconda-for-Python-Distribution-2\">Installation using Anaconda for Python Distribution</a></span><ul class=\"toc-item\"><li><ul class=\"toc-item\"><li><span><a href=\"#conda\" data-toc-modified-id=\"conda-2.0.1\">conda</a></span></li><li><span><a href=\"#Pipenv\" data-toc-modified-id=\"Pipenv-2.0.2\">Pipenv</a></span></li></ul></li></ul></li><li><span><a href=\"#Install-with-minimum-dependencies\" data-toc-modified-id=\"Install-with-minimum-dependencies-3\">Install with minimum dependencies</a></span></li><li><span><a href=\"#Installation-as-a-Docker-image\" data-toc-modified-id=\"Installation-as-a-Docker-image-4\">Installation as a Docker image</a></span></li><li><span><a href=\"#Install-Offline\" data-toc-modified-id=\"Install-Offline-5\">Install Offline</a></span><ul class=\"toc-item\"><li><ul class=\"toc-item\"><li><ul class=\"toc-item\"><li><span><a href=\"#1.-While-in-a-connected-environment,-download-the-appropriate-software-you'll-need:\" data-toc-modified-id=\"1.-While-in-a-connected-environment,-download-the-appropriate-software-you'll-need:-5.0.0.1\">1. While in a connected environment, download the appropriate software you'll need:</a></span></li><li><span><a href=\"#2.-Configure-Anaconda-for-use-in-the-disconnected-enviroment:\" data-toc-modified-id=\"2.-Configure-Anaconda-for-use-in-the-disconnected-enviroment:-5.0.0.2\">2. Configure Anaconda for use in the disconnected enviroment:</a></span></li><li><span><a href=\"#3.-Verify-the-install:\" data-toc-modified-id=\"3.-Verify-the-install:-5.0.0.3\">3. Verify the install:</a></span></li></ul></li></ul></li><li><span><a href=\"#Installation-for-older-versions\" data-toc-modified-id=\"Installation-for-older-versions-5.1\">Installation for older versions</a></span></li><li><span><a href=\"#Using-the-Deep-Learning-Frameworks-Installer\" data-toc-modified-id=\"Using-the-Deep-Learning-Frameworks-Installer-5.2\">Using the Deep Learning Frameworks Installer</a></span></li><li><span><a href=\"#Install-using-Python-Command-Prompt-or-Anaconda\" data-toc-modified-id=\"Install-using-Python-Command-Prompt-or-Anaconda-5.3\">Install using Python Command Prompt or Anaconda</a></span></li></ul></li><li><span><a href=\"#Test-your-install-with-jupyter-notebook\" data-toc-modified-id=\"Test-your-install-with-jupyter-notebook-6\">Test your install with jupyter notebook</a></span></li></ul></div>"
3526
]
3627
},
3728
{
@@ -231,6 +222,28 @@
231222
"``pipenv install arcgis``"
232223
]
233224
},
225+
{
226+
"cell_type": "markdown",
227+
"metadata": {},
228+
"source": [
229+
"## Install with minimum dependencies\n",
230+
"\n",
231+
"Both `conda install -c esri arcgis` and `pip install arcgis` will install all of the dependencies outlined in the [system requirements](https://developers.arcgis.com/python/guide/system-requirements/) section. However, the API can function in a 'stripped down' state with only a few dependencies. This allows developers to deploy the API with minimal footprint in space constrained environments. For this to work, you need to manually manage the dependencies in your environment based on the applications you need to solve and if you don't want to use every feature of the API. As of `v1.8.3` of the Python API, the minimum dependencies needed are:\n",
232+
"\n",
233+
" - `ujson`\n",
234+
" - `six`\n",
235+
" - `requests`\n",
236+
" - This library has its own dependencies that must be included\n",
237+
" - `requests_toolbelt`\n",
238+
" - `requests_ntlm`\n",
239+
" - This library has its own dependencies that must be included\n",
240+
" - `ntlm_auth`\n",
241+
"\n",
242+
"To install the API with no dependencies, simply add the `--no-deps` flag to any install command, i.e. `conda install -c esri arcgis --no-deps` or `pip install arcgis --no-deps`. \n",
243+
"\n",
244+
"The above set of dependencies should allow you to establish a connection with your web GIS and perform a number of administrative and other tasks which involve processing on your GIS rather than in your Python kernel. Depending on your OS, this set up with minimal dependencies should take up about `50` mb in space. As your needs expand, you can then manually choose which dependencies to add to your Python environment. For instance, you can install `pandas` if you require to work with spatially enabled DataFrames and `jupyter` if you need the notebook IDE."
245+
]
246+
},
234247
{
235248
"cell_type": "markdown",
236249
"metadata": {
@@ -347,19 +360,23 @@
347360
"cell_type": "markdown",
348361
"metadata": {},
349362
"source": [
350-
"You can click [here](#https://developers.arcgis.com/python/guide/install-and-set-up/) to install argis for older versions."
363+
"You can click [here](https://developers.arcgis.com/python/guide/install-older-versions/) to install `arcgis` for older versions."
351364
]
352365
},
353366
{
354367
"cell_type": "markdown",
355-
"metadata": {},
368+
"metadata": {
369+
"heading_collapsed": true
370+
},
356371
"source": [
357372
"# Install deep learning dependencies"
358373
]
359374
},
360375
{
361376
"cell_type": "markdown",
362-
"metadata": {},
377+
"metadata": {
378+
"hidden": true
379+
},
363380
"source": [
364381
"If you already have an environment with the `arcgis` package installed, you can further install its deep learning dependencies to take advantage of the `arcgis.learn` module. Some of the deep learning samples available [here](https://developers.arcgis.com/python/sample-notebooks/) can be referenced to understand the workflow.\n",
365382
"\n",
@@ -374,14 +391,18 @@
374391
},
375392
{
376393
"cell_type": "markdown",
377-
"metadata": {},
394+
"metadata": {
395+
"hidden": true
396+
},
378397
"source": [
379398
"### Install using Python Command Prompt or Anaconda"
380399
]
381400
},
382401
{
383402
"cell_type": "markdown",
384-
"metadata": {},
403+
"metadata": {
404+
"hidden": true
405+
},
385406
"source": [
386407
"To install deep learning packages in ArcGIS Pro, first ensure that ArcGIS Pro is installed.\n",
387408
"Using the steps below, you will create a new Python deep learning environment by cloning the default Python environment\n",
@@ -390,7 +411,9 @@
390411
},
391412
{
392413
"cell_type": "markdown",
393-
"metadata": {},
414+
"metadata": {
415+
"hidden": true
416+
},
394417
"source": [
395418
"For opening Python Command Prompt navigate to \n",
396419
"**Start** Menu &gt; **All Programs** &gt; **ArcGIS** &gt; **Python Command Prompt**\n",
@@ -410,7 +433,9 @@
410433
},
411434
{
412435
"cell_type": "markdown",
413-
"metadata": {},
436+
"metadata": {
437+
"hidden": true
438+
},
414439
"source": [
415440
"- For TensorFlow support (optional), use the following command:\n",
416441
"\n",
@@ -419,7 +444,9 @@
419444
},
420445
{
421446
"cell_type": "markdown",
422-
"metadata": {},
447+
"metadata": {
448+
"hidden": true
449+
},
423450
"source": [
424451
"- For Multispectral data support (optional and needed only for Anaconda users)\n",
425452
"\n",
@@ -428,22 +455,28 @@
428455
},
429456
{
430457
"cell_type": "markdown",
431-
"metadata": {},
458+
"metadata": {
459+
"hidden": true
460+
},
432461
"source": [
433462
"## Test your install with jupyter notebook"
434463
]
435464
},
436465
{
437466
"cell_type": "markdown",
438-
"metadata": {},
467+
"metadata": {
468+
"hidden": true
469+
},
439470
"source": [
440471
"To verify your arcgis installation, run the following commands in jupyter notebook:"
441472
]
442473
},
443474
{
444475
"cell_type": "code",
445476
"execution_count": 1,
446-
"metadata": {},
477+
"metadata": {
478+
"hidden": true
479+
},
447480
"outputs": [
448481
{
449482
"data": {
@@ -468,14 +501,18 @@
468501
},
469502
{
470503
"cell_type": "markdown",
471-
"metadata": {},
504+
"metadata": {
505+
"hidden": true
506+
},
472507
"source": [
473508
"To verify deep learning environment, run the following commands:"
474509
]
475510
},
476511
{
477512
"cell_type": "markdown",
478-
"metadata": {},
513+
"metadata": {
514+
"hidden": true
515+
},
479516
"source": [
480517
"``import fastai``\n",
481518
"\n",
@@ -486,7 +523,9 @@
486523
},
487524
{
488525
"cell_type": "markdown",
489-
"metadata": {},
526+
"metadata": {
527+
"hidden": true
528+
},
490529
"source": [
491530
"Run this command to check if cuda device is picked up for training a model on GPU.\n",
492531
"\n",
@@ -499,14 +538,18 @@
499538
},
500539
{
501540
"cell_type": "markdown",
502-
"metadata": {},
541+
"metadata": {
542+
"hidden": true
543+
},
503544
"source": [
504545
"[This overview](https://developers.arcgis.com/python/guide/overview-of-the-arcgis-api-for-python/) describes how to use ArcGIS API for Python to write Python code, incorporating capabilities such as mapping, query, analysis, geocoding, routing, portal administration, and more. Browse the sample notebooks to get started. You may choose to experience these [sample notebooks](https://developers.arcgis.com/python/sample-notebooks/) in a live environment as they are available as ArcGIS Notebooks."
505546
]
506547
},
507548
{
508549
"cell_type": "markdown",
509-
"metadata": {},
550+
"metadata": {
551+
"hidden": true
552+
},
510553
"source": [
511554
"\n",
512555
"> These are temporary environments which are erased after you close the browser tab. If you would like to save your changes, download your notebooks from the `File` menu of the Jupyter notebook IDE."
@@ -529,7 +572,20 @@
529572
"name": "python",
530573
"nbconvert_exporter": "python",
531574
"pygments_lexer": "ipython3",
532-
"version": "3.6.12"
575+
"version": "3.8.2"
576+
},
577+
"toc": {
578+
"base_numbering": 1,
579+
"nav_menu": {},
580+
"number_sections": false,
581+
"sideBar": false,
582+
"skip_h1_title": true,
583+
"title_cell": "Table of Contents",
584+
"title_sidebar": "Contents",
585+
"toc_cell": true,
586+
"toc_position": {},
587+
"toc_section_display": true,
588+
"toc_window_display": false
533589
}
534590
},
535591
"nbformat": 4,

0 commit comments

Comments
 (0)