|
12 | 12 | " - [Try the API live in a sandbox](#Try-it-live)\n", |
13 | 13 | " - Step 1: [Get Conda](#Step-1:-Get-Conda)\n", |
14 | 14 | " - [Get Conda with ArcGIS Pro](#Get-Conda-with-ArcGIS-Pro)\n", |
15 | | - " - [ArcGIS Pro 2.1](#Pro2.1)\n", |
| 15 | + " - [ArcGIS Pro 2.1 and later](#Pro2.1)\n", |
16 | 16 | " - [ArcGIS Pro 1.4 and 2.0.x](#Pro1.4)\n", |
17 | 17 | " - [ArcGIS Pro 1.3](#Pro1.3)\n", |
18 | 18 | " - [Get Conda with Anaconda for Python Distribution](#Get-Conda-with-Anaconda-for-Python-Distribution)\n", |
19 | 19 | " - Step 2: [Install the `arcgis` package](#Step:-2-Install-the-arcgis-package)\n", |
20 | 20 | " - [Install Using ArcGIS Pro Python Package Manager](#Install-using-ArcGIS-Pro-Python-Package-Manager)\n", |
21 | 21 | " - [Install Using the Python Command Prompt](#Install-using-Python-Command-Prompt)\n", |
22 | 22 | " - [Install Using Anaconda for Python Distribution](#Install-using-Anaconda-for-Python-Distribution)\n", |
23 | | - " - [Install Using pip](#Install-using-pip)\n", |
| 23 | + " - [Install Using pip or pipenv](#Install-using-pipenv-or-pip)\n", |
24 | 24 | " - [Install without Dependencies](#Install-without-Dependencies)\n", |
25 | 25 | " - [Upgrade the `arcgis` package](#Upgrade-the-arcgis-package)\n", |
| 26 | + " - [ArcGIS Pro 2.2](#ArcGIS-Pro-2.2)\n", |
26 | 27 | " - [ArcGIS Pro 2.1](#ArcGIS-Pro-2.1)\n", |
27 | 28 | " - [ArcGIS Pro 1.4 and 2.0.x](#ArcGIS-Pro-1.4-and-2.0.x)\n", |
28 | 29 | " - [Python Package Manager](#Python-Package-Manager)\n", |
|
53 | 54 | "## Step 1: Get Conda\n", |
54 | 55 | "\n", |
55 | 56 | "### Get Conda with ArcGIS Pro\n", |
56 | | - " - <a id=\"Pro2.1\" style=\"color:black\">ArcGIS Pro 2.1</a>\n", |
| 57 | + " - <a id=\"Pro2.1\" style=\"color:black\">ArcGIS Pro 2.1 and later</a>\n", |
57 | 58 | " \n", |
58 | | - " Proceed to [Using the API](#Using-the-API) for instructions. ArcGIS Pro 2.1 ships with conda and the `arcgis` package pre-installed.\n", |
| 59 | + " Proceed to [Using the API](#Using-the-API) for instructions. ArcGIS Pro 2.1 and later releases ship with conda and the `arcgis` package pre-installed.\n", |
59 | 60 | " - <a id=\"Pro1.4\" style=\"color:black\">ArcGIS Pro 1.4 and 2.0.x</a>\n", |
60 | 61 | "\n", |
61 | 62 | " Proceed to [Install with ArcGIS Pro Python Package Manager](#Install-using-ArcGIS-Pro-Python-Package-Manager) for instructions on installing the `arcgis` package. ArcGIS Pro 1.4 ships with conda installed.\n", |
|
75 | 76 | "## Step: 2 Install the `arcgis` package\n", |
76 | 77 | "### Install using ArcGIS Pro [Python Package Manager](http://pro.arcgis.com/en/pro-app/arcpy/get-started/what-is-conda.htm)\n", |
77 | 78 | "\n", |
78 | | - " ArcGIS Pro 1.4 and later provides the Python Package Manager GUI to download and install any conda package. Access it through the ArcGIS Pro backstage area:\n", |
| 79 | + " ArcGIS Pro 1.4 and later provide the Python Package Manager GUI to download and install any conda package. Access it through the ArcGIS Pro backstage area:\n", |
79 | 80 | " * Open ArcGIS Pro with a new blank Project\n", |
80 | 81 | " * Select the Project tab to access the Pro backstage (see screen shot below)\n", |
81 | 82 | " * Select the 'Python' menu option\n", |
|
84 | 85 | " * Select the release you want to install\n", |
85 | 86 | " * Click 'Install' and accept the terms and conditions\n", |
86 | 87 | "\n", |
87 | | - "\n", |
| 88 | + "\n", |
88 | 89 | "\n", |
89 | 90 | "To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)**\n", |
90 | 91 | "\n", |
|
98 | 99 | " conda install -c esri arcgis\n", |
99 | 100 | " ```\n", |
100 | 101 | "\n", |
101 | | - "\n", |
| 102 | + "\n", |
102 | 103 | "\n", |
103 | 104 | "To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)**\n", |
104 | 105 | "\n", |
|
118 | 119 | "\n", |
119 | 120 | "To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)**\n", |
120 | 121 | "\n", |
121 | | - "### Install using pip\n", |
| 122 | + "### Install using pipenv or pip\n", |
122 | 123 | "\n", |
123 | | - "[Pip](https://pip.pypa.io/en/stable/) is a package management system used to install and manage software packages written in Python, similar to conda. Many pip packages can be found in the [Python Package Index (PyPI)](https://pypi.python.org/pypi), including the ArcGIS API for Python pip package. To install the API with pip, open a terminal and enter the following command:\n", |
| 124 | + "#### Pipenv\n", |
| 125 | + "[Pipenv](https://docs.pipenv.org/) is the official packaging tool for managing environments and installing packages from the [Python Package Index (PyPI)](https://pypi.python.org/pypi). To install the ArcGIS API for Python from PyPI in a new environment, create a new folder named `your-folder`. Open a terminal, and run `cd /path/to/your-folder` to change directories into `your-folder`. Then, enter the following command to simultaneously create a new environment and install the API in it:\n", |
| 126 | + "\n", |
| 127 | + "```\n", |
| 128 | + "pipenv install arcgis\n", |
| 129 | + "```\n", |
| 130 | + "\n", |
| 131 | + "After running this command, you will notice that a new file named `Pipfile` was created in `your-folder`. A [Pipfile](https://github.com/pypa/pipfile) contains package information that represents a python environment. Open your terminal and make sure you are still in the `your-folder` directory; then, run `pipenv shell`. You have now activated your python environment, the environment that contains the `arcgis` package! You can run `jupyter notebook` or `python` in this environment to start using the API.\n", |
124 | 132 | " \n", |
125 | | - "```python\n", |
| 133 | + "Pipenv differs from conda and other environment managers in that environments are specific to the folder that contains the Pipfile. In this way, pipenv's use of `Pipfile` is similar to how `npm` uses `package.json`. To learn more about installing and using pipenv, click [here](https://docs.pipenv.org/) or [here](http://docs.python-guide.org/en/latest/dev/virtualenvs/#installing-packages-for-your-project).\n", |
| 134 | + "\n", |
| 135 | + "> __Tip__: You can run any command in an environment without activating it by running `pipenv run {insert_command_here}` in a directory with a valid Pipfile.\n", |
| 136 | + "\n", |
| 137 | + "#### Pip\n", |
| 138 | + "\n", |
| 139 | + "[Pip](https://pip.pypa.io/en/stable/) is the predecessor of pipenv, and can also be used to install packages from PyPI (but you must manage environments with seperate tools like [virtualenv](https://virtualenv.pypa.io/en/stable/)). To install the API with pip, open a terminal and enter the following command:\n", |
| 140 | + " \n", |
| 141 | + "```\n", |
126 | 142 | "pip install arcgis\n", |
127 | 143 | "```\n", |
128 | 144 | "\n", |
129 | | - "Pip and conda are totally seperate package managers, and should avoid being used interchangeably. It is recommended you use conda to install the API if you are a beginner user. [Read more about the differences](https://stackoverflow.com/questions/20994716/what-is-the-difference-between-pip-and-conda).\n", |
| 145 | + "#### Disclaimer\n", |
| 146 | + "You should avoid mixing conda with pipenv/pip: they are completely seperate package managers. It is recommended that you use conda to install the API if you are a beginner user. Read more about the differences [here](https://stackoverflow.com/questions/20994716/what-is-the-difference-between-pip-and-conda) and [here](http://docs.python-guide.org/en/latest/dev/virtualenvs/).\n", |
130 | 147 | "\n", |
131 | | - "> Note: when installing the ArcGIS API for Python with pip, some dependencies may require Microsoft Visual C++ 14.0. If you see any errors related to this, either install the Microsoft Visual C++ tools or install the API without dependencies.\n", |
| 148 | + "> __Note__: when installing the ArcGIS API for Python with pipenv/pip, some dependencies may require Microsoft Visual C++ 14.0. If you see any errors related to this, either install the Microsoft Visual C++ tools or install the API without dependencies.\n", |
132 | 149 | "\n", |
133 | 150 | "### Install without Dependencies\n", |
134 | 151 | "\n", |
|
138 | 155 | "\n", |
139 | 156 | "***\n", |
140 | 157 | "## Upgrade the `arcgis` package\n", |
| 158 | + "#### ArcGIS Pro 2.2\n", |
| 159 | + "ArcGIS Pro 2.2 ships with the ArcGIS API for Python 1.4.1 installed. The initial ArcGIS Pro installation creates a default read-only conda environment named `arcgispro-py3`. To upgrade the ArcGIS API for Python package, use the [`Python Package Manager`](http://pro.arcgis.com/en/pro-app/arcpy/get-started/what-is-conda.htm) to create a new environment and then install the latest release of the ArcGIS API for Python:\n", |
| 160 | + " * Open ArcGIS Pro with a new blank Project\n", |
| 161 | + " * Select the Project tab to access the Pro backstage (see screenshot below)\n", |
| 162 | + " * Select the Python menu option\n", |
| 163 | + " * Click `Manage Environments`, then click `New`\n", |
| 164 | + " \n", |
| 165 | + " \n", |
| 166 | + " \n", |
| 167 | + " * Type a name for the new environment and click `Save`\n", |
| 168 | + " \n", |
| 169 | + " \n", |
| 170 | + " * **Allow blue progress bar at the bottom of the dialog to complete.** Proceeding before this completes could result in an incomplete environment that may not perform properly.\n", |
| 171 | + " \n", |
| 172 | + " \n", |
| 173 | + " * Select the Active radio button to make the new enviroment active\n", |
| 174 | + " \n", |
| 175 | + " \n", |
| 176 | + " \n", |
| 177 | + " * Close the Manage Environments dialog and close ArcGIS Pro\n", |
| 178 | + " * Open the Python Command Prompt: Start > All Programs > > ArcGIS > ArcGIS Pro > Python Command Prompt\n", |
| 179 | + " * Type the command below:\n", |
| 180 | + " `conda upgrade -c esri arcgis`\n", |
| 181 | + "\n", |
| 182 | + " \n", |
| 183 | + "\n", |
| 184 | + "* Type `y` to Proceed:\n", |
| 185 | + "\n", |
| 186 | + " \n", |
| 187 | + "* Type\n", |
| 188 | + " `conda list arcgis` to verify the upgrade:\n", |
| 189 | + " \n", |
| 190 | + "\n", |
| 191 | + "\n", |
141 | 192 | "#### ArcGIS Pro 2.1\n", |
142 | 193 | "ArcGIS Pro 2.1 ships with the ArcGIS API for Python 1.2.5 installed. To update to the newest release, proceed to to run the command below from either a Terminal window with the arcgispro-py3 environment active, or the **Python Command Prompt**:\n", |
143 | 194 | "\n", |
|
208 | 259 | " \n", |
209 | 260 | "You should see a map come up as shown below:\n", |
210 | 261 | "\n", |
211 | | - "\n", |
| 262 | + "\n", |
212 | 263 | "\n", |
213 | | - "Learn more about the API using the [guide](https://developers.arcgis.com/python/guide/) and try out the [samples](https://developers.arcgis.com/python/sample-notebooks/)." |
| 264 | + "Learn more about the API using the [guide](../) and try out the [samples](../../sample-notebooks/)." |
214 | 265 | ] |
215 | 266 | }, |
216 | 267 | { |
|
233 | 284 | " \n", |
234 | 285 | " `docker pull esridocker/arcgis-api-python-notebook`\n", |
235 | 286 | " \n", |
236 | | - " \n", |
| 287 | + " \n", |
237 | 288 | "\n", |
238 | 289 | "\n", |
239 | 290 | " * 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", |
|
243 | 294 | "\n", |
244 | 295 | " * 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.\n", |
245 | 296 | " \n", |
246 | | - "<h2><a name=\"Install-Offline\" style=\"color:black\"><strong>Install Offline</strong></a></h2>\n", |
| 297 | + "## Install-Offline\n", |
247 | 298 | "\n", |
248 | 299 | "Install the API on a machine without internet access or on a disconnected network with the following steps:\n", |
249 | 300 | " \n", |
|
261 | 312 | "<br>\n", |
262 | 313 | "**NOTE:** For advanced users or those needing information on specific environments, see [Configuration](https://conda.io/docs/user-guide/configuration/use-condarc.html) for options to configure various aspects of conda" |
263 | 314 | ] |
264 | | - }, |
265 | | - { |
266 | | - "cell_type": "code", |
267 | | - "execution_count": null, |
268 | | - "metadata": {}, |
269 | | - "outputs": [], |
270 | | - "source": [] |
271 | 315 | } |
272 | 316 | ], |
273 | 317 | "metadata": { |
|
287 | 331 | "name": "python", |
288 | 332 | "nbconvert_exporter": "python", |
289 | 333 | "pygments_lexer": "ipython3", |
290 | | - "version": "3.5.5" |
| 334 | + "version": "3.6.5" |
291 | 335 | }, |
292 | 336 | "varInspector": { |
293 | 337 | "cols": { |
|
0 commit comments