Skip to content

Commit 57b0b54

Browse files
committed
Added dependencies information and pip installation information
1 parent 9ce6477 commit 57b0b54

File tree

2 files changed

+42
-4
lines changed

2 files changed

+42
-4
lines changed

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
" - [Install Using ArcGIS Pro Python Package Manager](#Install-using-ArcGIS-Pro-Python-Package-Manager)\n",
2121
" - [Install Using the Python Command Prompt](#Install-using-Python-Command-Prompt)\n",
2222
" - [Install Using Anaconda for Python Distribution](#Install-using-Anaconda-for-Python-Distribution)\n",
23+
" - [Install Using pip](#Install-using-pip)\n",
24+
" - [Dependences](#Dependencies)\n",
2325
" - [Upgrade the `arcgis` package](#Upgrade-the-arcgis-package)\n",
2426
" - [ArcGIS Pro 2.1](#ArcGIS-Pro-2.1)\n",
2527
" - [ArcGIS Pro 1.4 and 2.0.x](#ArcGIS-Pro-1.4-and-2.0.x)\n",
@@ -115,6 +117,23 @@
115117
"![install arcgis package mac](http://esri.github.io/arcgis-python-api/notebooks/nbimages/install_arcgis_pkg_mac.png)\n",
116118
"\n",
117119
"To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)** \n",
120+
"\n",
121+
"### Install using pip\n",
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",
124+
" \n",
125+
"```python\n",
126+
"pip install arcgis\n",
127+
"```\n",
128+
"\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",
130+
"\n",
131+
"### Dependencies\n",
132+
"\n",
133+
"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 the ```six``` dependency. This means you can manually manage the dependencies on your system if you don't want to use every feature of the API. \n",
134+
"\n",
135+
"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```. You can then manually choose which dependencies, if any, to add to your Python environment.\n",
136+
"\n",
118137
"***\n",
119138
"## Upgrade the `arcgis` package\n",
120139
"#### ArcGIS Pro 2.1\n",
@@ -259,7 +278,7 @@
259278
"name": "python",
260279
"nbconvert_exporter": "python",
261280
"pygments_lexer": "ipython3",
262-
"version": "3.5.3"
281+
"version": "3.6.4"
263282
},
264283
"varInspector": {
265284
"cols": {

guide/01-getting-started/system-requirements.ipynb

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,26 @@
66
"source": [
77
"# System requirements\n",
88
"\n",
9-
"In order to use version ArcGIS API for Python, you need Python 3.5 or later."
9+
"## Operating System \n",
10+
"The ArcGIS API for Python is compatible with 32-bit and 64-bit versions of Windows, macOS, and Linux.\n",
11+
"\n",
12+
"## Python Version\n",
13+
"Python 3.5 or later is required to use the ArcGIS API for Python.\n",
14+
"\n",
15+
"## Dependencies\n",
16+
"\n",
17+
"The arcgis package can function with only the [six](https://pypi.python.org/pypi/six) dependency installed in your python environment. However, there are additional dependencies needed to use specific features of the arcgis package, some of which may have been included during your pip or conda install. Here is a full list of all dependencies:\n",
18+
"\n",
19+
"* [six](https://pypi.python.org/pypi/six)\n",
20+
"* [pandas](https://pandas.pydata.org/)\n",
21+
"* [numpy](http://www.numpy.org/)\n",
22+
"* [pyshp](https://pypi.python.org/pypi/pyshp/)\n",
23+
"* [matplotlib](https://matplotlib.org/)\n",
24+
"* [notebook](https://ipython.org/notebook.html)\n",
25+
"* [ipywidgets >=5.2.2,<7](https://ipywidgets.readthedocs.io/en/stable/)\n",
26+
"* [widgetsnbextension >=1.2.6,<3](https://pypi.python.org/pypi/widgetsnbextension)\n",
27+
"* [keyring](https://pypi.python.org/pypi/keyring/10.6.0)\n",
28+
"* [winkerberos](https://pypi.python.org/pypi/winkerberos/0.7.0) (Windows only)"
1029
]
1130
}
1231
],
@@ -26,9 +45,9 @@
2645
"name": "python",
2746
"nbconvert_exporter": "python",
2847
"pygments_lexer": "ipython3",
29-
"version": "3.5.2"
48+
"version": "3.6.4"
3049
}
3150
},
3251
"nbformat": 4,
33-
"nbformat_minor": 0
52+
"nbformat_minor": 1
3453
}

0 commit comments

Comments
 (0)