Skip to content

Commit 96cb516

Browse files
AtmaManirohitgeo
AtmaMani
authored and
rohitgeo
committed
Added install instructions for using as docker containers (Esri#84)
* Fix wrong location in comment * Merge dev branch into master for 0.2 Beta and Holistic Testing (Esri#24) * Updated publishing samples to reflect changes made to source code * Updated Publihing SDs, shp, csv samples to reflect latest API changes * Publisher sample updates - added samples for web maps and web scene (Esri#3) * Updated notebook title to match filename * Added a new sample to showcase publishing web maps and web scenes * Fixed credentials * Updated sample titled "Using and updating GIS content" (Esri#4) * Updated notebook title to match filename * Added a new sample to showcase publishing web maps and web scenes * Fixed credentials * Updated the sample with additional examples * Fixed credentials * Added an example for line featuers. Added some text explaining what smart mapping is * Additional widgets to minimize scrolling. Fixed geocoder usage following API update * Updated geocoder usage to match API updates * Updated the sample to match gp service update. Added a bit more text explaining the usage of gp tools (Esri#12) * Minor - updated sample to search for desired item to add instead of a fixed index (Esri#13) * GIS analysts - sample illustrating spatial analysis using ArcGIS Python API (Esri#14) * Initial commit * Furnished the sample with spatial analysis examples * Fixes for API changes. Added summary text and elaborated a few steps (Esri#15) * new sample to showcase big data anlaysis using NYC taxi example (Esri#16) * Updated hurricane tracks sample to match API changes (Esri#17) * Updated hurricane tracks sample to match API changes and added descriptive text * updated credentials * Updated sample to match API changes, added explanatory text (Esri#19) * clean up sample (Esri#18) * clean up sample (Esri#20) * Remove usage statistics notebook as the API isnt available This requires work on the portal backend as well as it does not yet support ASM. * bug fixes and added descriptive text (Esri#22) * synced raster product sample in 05 Content Publishers folder to match that in 04 GIS Analysts and Data Scientists (Esri#21) Thanks, @AtmaMani * Updated Overview page - updated sample TOC (Esri#23) * doc updates * apidoc update for 0.2 beta release * updated install instructions * Updated samples download link to point to v0.2-beta release (Esri#25) * fixed wrong import * fixed execution count * ignore IDE files * added try it live and docker to install instructions
1 parent 5e7cf54 commit 96cb516

2 files changed

Lines changed: 62 additions & 5 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
guide/gis module/.ipynb_checkpoints/class gis.ContentManager-checkpoint.ipynb
2-
.ipynb_checkpoints
2+
.ipynb_checkpoints
3+
.idea

‎guide/01 Getting Started/Install and set up.ipynb‎

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,39 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Install using Conda\n",
7+
"There are multiple ways in which you can experience the ArcGIS API for Python and its SDK. You can either install the API and SDK using conda or try it using the live sandbox or get it as a Docker image.\n",
8+
"\n",
9+
" - [Try the API live in a sandbox](#Try-it-live)\n",
10+
" - [Install the API in your computer using conda](#Install-using-Conda)\n",
11+
" - [Install using ArcGIS Pro](#Install-using-ArcGIS-Pro)\n",
12+
" - [Install the API as a Docker image](#Install-as-a-Docker-image)\n"
13+
]
14+
},
15+
{
16+
"cell_type": "markdown",
17+
"metadata": {},
18+
"source": [
19+
"## Try it live\n",
20+
"The API is now available in a live sandbox. You may choose to experience it in the sandbox before going ahead with the installation. Click the link below to launch a temporary Jupyter notebook environment. \n",
21+
"\n",
22+
"<a class=\"btn\" href=\"//notebooks.esri.com/\" target=\"_blank\">Try it live</a>\n",
23+
"\n",
24+
"Note, 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."
25+
]
26+
},
27+
{
28+
"cell_type": "markdown",
29+
"metadata": {},
30+
"source": [
31+
"## Install using Conda\n",
832
"\n",
933
"The ArcGIS API for Python is distributed via conda. [Conda](http://conda.pydata.org/docs/get-started.html) is a popular package and environment manager application that helps you install and update packages such as the ArcGIS Python API and their dependencies. You can install the API through two main workflows - install through anaconda or install using ArcGIS Pro. Both are outlined below.\n",
1034
"\n",
11-
"## Step: 1 Get Conda\n",
35+
"### Step: 1 Get Conda\n",
1236
"Install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3x), if you don't already have conda. The ArcGIS API for Python requires Python 3.5 or higher.\n",
1337
"If you have installed ArcGIS Pro 1.4 or later, you already have conda.\n",
1438
"\n",
15-
"## Step: 2 Install `arcgis` package\n",
39+
"### Step: 2 Install `arcgis` package\n",
1640
"To download and install the API in your conda environment, type the following command in your terminal.\n",
1741
"\n",
1842
" conda install -c esri arcgis\n",
@@ -78,11 +102,43 @@
78102
"\n",
79103
"Next, you can learn more about the API using the [guide](/python/guide/) and try out the [samples](/python/sample-notebooks/)."
80104
]
105+
},
106+
{
107+
"cell_type": "markdown",
108+
"metadata": {
109+
"collapsed": true
110+
},
111+
"source": [
112+
"---------------------------------------\n",
113+
"## Install as a Docker image\n",
114+
"\n",
115+
"[Docker](https://www.docker.com) is a popular containerization technology. Docker containers bundle software in a complete file system with everything that is needed to run it. Docker containers run the same regardless of your operating system. To learn more about docker, refer to [the official documentation](https://docs.docker.com/engine/getstarted/).\n",
116+
"\n",
117+
"The ArcGIS API for Python is shipped as a [Docker image](https://hub.docker.com/r/esridocker/arcgis-api-python-notebook/) which you can download and power up whenever you want to use the API. These images when spun up into containers, run in an isolated environment without making any changes to your local file system.\n",
118+
"\n",
119+
"Follow the steps below to get Docker on your computer and run the API:\n",
120+
"\n",
121+
" * [Download docker](https://www.docker.com/products/overview) and [install](https://docs.docker.com/engine/installation/) it on your computer.\n",
122+
" * Once installed, run the following command in terminal to pull Docker image\n",
123+
" \n",
124+
" `docker pull esridocker/arcgis-api-python-notebook`\n",
125+
" \n",
126+
" ![docker pull command](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_04.PNG)\n",
127+
"\n",
128+
"\n",
129+
" * Then spin the image into a container using the following command in terminal. Replace the `<localport>` with an available port number, for instance `8889`. \n",
130+
" \n",
131+
" `docker run -it -p <localport>:8888 esridocker/arcgis-api-python-notebook`\n",
132+
"\n",
133+
"\n",
134+
" * When the container starts, it will provide a URL (with a one time token) to open your local Notebook instance. Copy the URL and paste it in your browser's address bar to use the notebooks."
135+
]
81136
}
82137
],
83138
"metadata": {
139+
"anaconda-cloud": {},
84140
"kernelspec": {
85-
"display_name": "Python 3",
141+
"display_name": "Python [default]",
86142
"language": "python",
87143
"name": "python3"
88144
},

0 commit comments

Comments
 (0)