|
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 | 26 | " - [ArcGIS Pro 2.1](#ArcGIS-Pro-2.1)\n", |
|
84 | 84 | " * Select the release you want to install\n", |
85 | 85 | " * Click 'Install' and accept the terms and conditions\n", |
86 | 86 | "\n", |
87 | | - "\n", |
| 87 | + "\n", |
88 | 88 | "\n", |
89 | 89 | "To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)**\n", |
90 | 90 | "\n", |
|
98 | 98 | " conda install -c esri arcgis\n", |
99 | 99 | " ```\n", |
100 | 100 | "\n", |
101 | | - "\n", |
| 101 | + "\n", |
102 | 102 | "\n", |
103 | 103 | "To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)**\n", |
104 | 104 | "\n", |
|
118 | 118 | "\n", |
119 | 119 | "To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)**\n", |
120 | 120 | "\n", |
121 | | - "### Install using pip\n", |
| 121 | + "### Install using pipenv or pip\n", |
122 | 122 | "\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", |
| 123 | + "#### Pipenv\n", |
| 124 | + "[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", |
| 125 | + "\n", |
| 126 | + "```\n", |
| 127 | + "pipenv install arcgis\n", |
| 128 | + "```\n", |
| 129 | + "\n", |
| 130 | + "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 | 131 | " \n", |
125 | | - "```python\n", |
| 132 | + "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", |
| 133 | + "\n", |
| 134 | + "> __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", |
| 135 | + "\n", |
| 136 | + "#### Pip\n", |
| 137 | + "\n", |
| 138 | + "[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", |
| 139 | + " \n", |
| 140 | + "```\n", |
126 | 141 | "pip install arcgis\n", |
127 | 142 | "```\n", |
128 | 143 | "\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", |
| 144 | + "#### Disclaimer\n", |
| 145 | + "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 | 146 | "\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", |
| 147 | + "> __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 | 148 | "\n", |
133 | 149 | "### Install without Dependencies\n", |
134 | 150 | "\n", |
|
208 | 224 | " \n", |
209 | 225 | "You should see a map come up as shown below:\n", |
210 | 226 | "\n", |
211 | | - "\n", |
| 227 | + "\n", |
212 | 228 | "\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/)." |
| 229 | + "Learn more about the API using the [guide](../) and try out the [samples](../../sample-notebooks/)." |
214 | 230 | ] |
215 | 231 | }, |
216 | 232 | { |
|
233 | 249 | " \n", |
234 | 250 | " `docker pull esridocker/arcgis-api-python-notebook`\n", |
235 | 251 | " \n", |
236 | | - " \n", |
| 252 | + " \n", |
237 | 253 | "\n", |
238 | 254 | "\n", |
239 | 255 | " * 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 | 259 | "\n", |
244 | 260 | " * 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 | 261 | " \n", |
246 | | - "<h2><a name=\"Install-Offline\" style=\"color:black\"><strong>Install Offline</strong></a></h2>\n", |
| 262 | + "## Install-Offline\n", |
247 | 263 | "\n", |
248 | 264 | "Install the API on a machine without internet access or on a disconnected network with the following steps:\n", |
249 | 265 | " \n", |
|
261 | 277 | "<br>\n", |
262 | 278 | "**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 | 279 | ] |
264 | | - }, |
265 | | - { |
266 | | - "cell_type": "code", |
267 | | - "execution_count": null, |
268 | | - "metadata": {}, |
269 | | - "outputs": [], |
270 | | - "source": [] |
271 | 280 | } |
272 | 281 | ], |
273 | 282 | "metadata": { |
|
287 | 296 | "name": "python", |
288 | 297 | "nbconvert_exporter": "python", |
289 | 298 | "pygments_lexer": "ipython3", |
290 | | - "version": "3.5.5" |
| 299 | + "version": "3.6.5" |
291 | 300 | }, |
292 | 301 | "varInspector": { |
293 | 302 | "cols": { |
|
0 commit comments