Skip to content

Commit

Permalink
Merge pull request #179 from jyaistMap/guide-install-sys-req
Browse files Browse the repository at this point in the history 
In interest of time, let us break out the Pro install pages for after DevSummit (March 2018)
  • Loading branch information
@AtmaMani
AtmaMani committed Feb 28, 2018
2 parents f666261 + 8deda79 commit 068df0f
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 17 deletions.
73 changes: 62 additions & 11 deletions guide/01-getting-started/install-and-set-up.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,21 @@
" - Step 1: [Get Conda](#Step-1:-Get-Conda)\n",
" - [Get Conda with ArcGIS Pro](#Get-Conda-with-ArcGIS-Pro)\n",
" - [ArcGIS Pro 2.1](#Pro2.1)\n",
" - [ArcGIS Pro 1.4](#Pro1.4)\n",
" - [ArcGIS Pro 1.4 and 2.0.x](#Pro1.4)\n",
" - [ArcGIS Pro 1.3](#Pro1.3)\n",
" - [Get Conda with Anaconda for Python Distribution](#Get-Conda-with-Anaconda-for-Python-Distribution)\n",
" - Step 2: [Install the `arcgis` package](#Step:-2-Install-the-arcgis-package)\n",
" - [Install Using ArcGIS Pro Python Package Manager](#Install-using-ArcGIS-Pro-Python-Package-Manager)\n",
" - [Install Using the Python Command Prompt](#Install-using-Python-Command-Prompt)\n",
" - [Install Using Anaconda for Python Distribution](#Install-using-Anaconda-for-Python-Distribution)\n",
" - [Install Using pip](#Install-using-pip)\n",
" - [Install without Dependencies](#Install-without-Dependencies)\n",
" - [Upgrade the `arcgis` package](#Upgrade-the-arcgis-package)\n",
" - [ArcGIS Pro 2.1](#ArcGIS-Pro-2.1)\n",
" - [ArcGIS Pro 1.4 and 2.0.x](#ArcGIS-Pro-1.4-and-2.0.x)\n",
" - [Python Package Manager](#Python-Package-Manager)\n",
" - [Terminal Window or Python Command Prompt](#Terminal-Window-or-Python-Command-Prompt)\n",
" - [ArcGIS Pro 1.3](#ArcGIS-Pro-1.3)\n",
" - [Using the API](#Using-the-API)\n",
" - [Test your Install with Jupyter Notebook](#Test-your-install-with-jupyter-notebook) \n",
" - [Install as a Docker image](#Install-as-a-Docker-image)\n",
Expand Down Expand Up @@ -49,7 +56,7 @@
" - <a id=\"Pro2.1\" style=\"color:black\">ArcGIS Pro 2.1</a>\n",
" \n",
" Proceed to [Using the API](#Using-the-API) for instructions. ArcGIS Pro 2.1 ships with conda and the `arcgis` package pre-installed.\n",
" - <a id=\"Pro1.4\" style=\"color:black\">ArcGIS Pro 1.4</a>\n",
" - <a id=\"Pro1.4\" style=\"color:black\">ArcGIS Pro 1.4 and 2.0.x</a>\n",
"\n",
" 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",
" - <a id=\"Pro1.3\" style=\"color:black\">ArcGIS Pro 1.3</a>\n",
Expand All @@ -73,8 +80,9 @@
" * Select the Project tab to access the Pro backstage (see screen shot below)\n",
" * Select the 'Python' menu option\n",
" * Click the 'Add Packages' button and type `arcgis` into the search bar\n",
" * You may have to click the 'refresh' button to ensure you are getting the latest version of the package\n",
" * click 'Install' and accept the terms and conditions\n",
" * You may have to click the 'refresh' button to ensure you get the complete list of available releases. You will be able to install up to release 1.2.5. To upgrade to a package beyond the 1.2.5 release, see [Upgrade the `arcgis` package](#Upgrade-the-arcgis-package)\n",
" * Select the release you want to install\n",
" * Click 'Install' and accept the terms and conditions\n",
"\n",
"![install using ArcGIS Pro](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_03.PNG)\n",
"\n",
Expand All @@ -99,7 +107,7 @@
"\n",
"\n",
"\n",
"<h3><a name=\"Install-with-Anaconda\" style=\"color:black\"><strong>Install using Anaconda for Python Distribution</strong></a></h3>\n",
"### Install using Anaconda for Python Distribution\n",
"\n",
"Open a terminal application and install the API with the following command:\n",
"```python\n",
Expand All @@ -109,12 +117,55 @@
"![install arcgis package mac](http://esri.github.io/arcgis-python-api/notebooks/nbimages/install_arcgis_pkg_mac.png)\n",
"\n",
"To use the API in different IDEs, proceed to **[Using the API](#Using-the-API)** \n",
"\n",
"### Install using pip\n",
"\n",
"[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",
" \n",
"```python\n",
"pip install arcgis\n",
"```\n",
"\n",
"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",
"\n",
"### Install without Dependencies\n",
"\n",
"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",
"\n",
"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",
"\n",
"***\n",
"## Upgrade the `arcgis` package\n",
"If you had previously installed the ArcGIS API for Python and are upgrading from an older version, run the following command in your terminal or **Python Command Prompt**:\n",
"#### ArcGIS Pro 2.1\n",
"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",
"\n",
"```python\n",
" conda upgrade -c esri --no-pin arcgis\n",
"```\n",
"#### ArcGIS Pro 1.4 and 2.0.x\n",
"##### Python Package Manager\n",
" * Open ArcGIS Pro with a new blank Project\n",
" * Select the Project tab to access the Pro backstage (see screen shot below)\n",
" * Select the 'Python' menu option\n",
" * Use the **Project Environment** dropdown to chooose the appropriate environment\n",
" * Select the `Update Packages` option\n",
" * Choose the appropriate arcgis release from the list of packages with recent updates\n",
" \n",
" ![python_package_manager_update_pkg](http://esri.github.io/arcgis-python-api/notebooks/nbimages/python_package_manager_update_pkg.png)\n",
" \n",
" * Click the Update button\n",
" \n",
"##### Terminal Window or **Python Command Prompt**\n",
"Activate the environment containing the `arcgis` package and type:\n",
"```python\n",
"conda upgrade -c esri arcgis\n",
"```\n",
"\n",
"#### ArcGIS Pro 1.3 \n",
"\n",
"ArcGIS Pro 1.3 will install the ArcGIS API for Python 1.0 (the `arcgis 1.0` package) release. To upgrade the `arcgis` package you would have to install a later release of ArcGIS Pro.\n",
"\n",
" conda upgrade -c esri arcgis\n",
"--------------------------------\n",
" --------------------------------\n",
"## Using the API\n",
"#### Start the [Jupyter notebook](http://jupyter.org/) installed with the API:\n",
" \n",
Expand Down Expand Up @@ -213,9 +264,9 @@
"metadata": {
"anaconda-cloud": {},
"kernelspec": {
"display_name": "Python [conda env:arcgis-pyapi]",
"display_name": "Python 3",
"language": "python",
"name": "conda-env-arcgis-pyapi-py"
"name": "python3"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -227,7 +278,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.5.3"
"version": "3.6.3"
},
"varInspector": {
"cols": {
Expand Down
26 changes: 23 additions & 3 deletions guide/01-getting-started/system-requirements.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,27 @@
"source": [
"# System requirements\n",
"\n",
"In order to use version ArcGIS API for Python, you need Python 3.5 or later."
"## Operating System \n",
"The ArcGIS API for Python is compatible with 32-bit and 64-bit versions of Windows, macOS, and Linux.\n",
"\n",
"## Python Version\n",
"Python 3.5 or later is required to use the ArcGIS API for Python.\n",
"\n",
"## Dependencies\n",
"The full power of the ArcGIS API for Python is best experienced when all its dependencies are installed. However, specific tasks such as GIS administration and content management can be accopmplished even when installed with just the [`six`](https://pypi.python.org/pypi/six) package. See [Install without Dependencies](../install-and-set-up/#Install-without-Dependencies) to install the `arcgis` package in this manner.\n",
"\n",
"However, there are additional dependencies needed to use specific features of the ArcGIS API for Python. In order to utilize the ArcGIS API for Python in its full capacity, it is recommended to install the `arcgis` package with pip or conda as all these dependencies are installed. See the fill list below:\n",
"\n",
"* [six](https://pypi.python.org/pypi/six)\n",
"* [pandas](https://pandas.pydata.org/)\n",
"* [numpy](http://www.numpy.org/)\n",
"* [pyshp](https://pypi.python.org/pypi/pyshp/)\n",
"* [matplotlib](https://matplotlib.org/)\n",
"* [notebook](https://ipython.org/notebook.html)\n",
"* [ipywidgets >=5.2.2,<7](https://ipywidgets.readthedocs.io/en/stable/)\n",
"* [widgetsnbextension >=1.2.6,<3](https://pypi.python.org/pypi/widgetsnbextension)\n",
"* [keyring](https://pypi.python.org/pypi/keyring/10.6.0)\n",
"* [winkerberos](https://pypi.python.org/pypi/winkerberos/0.7.0) (Windows only)"
]
}
],
Expand All @@ -26,9 +46,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.5.2"
"version": "3.6.3"
}
},
"nbformat": 4,
"nbformat_minor": 0
"nbformat_minor": 1
}
6 changes: 3 additions & 3 deletions guide/01-getting-started/understanding-conda.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,9 @@
"metadata": {
"anaconda-cloud": {},
"kernelspec": {
"display_name": "Python [conda env:arcgis-pyapi]",
"display_name": "Python 3",
"language": "python",
"name": "conda-env-arcgis-pyapi-py"
"name": "python3"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -174,7 +174,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.5.3"
"version": "3.6.4"
},
"varInspector": {
"cols": {
Expand Down

0 comments on commit 068df0f

Please sign in to comment.