Skip to content

installation

Jump to bottom
Nick Santos edited this page Mar 1, 2017 · 8 revisions

Setting ArcProject code up

The instructions below include steps to install in ArcMap or ArcGIS Pro - you only need to follow one of the two sets of steps based on which piece of software you have installed and plan to use.

Basic Setup - ArcMap

Note: You must be running ArcGIS 10.4 or above to use this software!

  1. Make sure your computer is licensed to run ArcGIS - if you need to connect to the VPN to run ArcGIS, connect now before starting the installation process.
  2. Download the installation package with the arcproject code, and extract the zip file to a folder on your computer. Remember where you extracted these files
  3. In Windows, navigate to C:\Python27. In that folder, you may have many other folders, some of which will start with ArcGIS and be written like ArcGIS10.3 - note the highest version number folder (for example, if you have folders named ArcGIS10.3 and ArcGIS10.4 you want to note ArcGIS10.4) - we'll use it in a moment.
  4. Open a command prompt and navigate to the folder where you extracted the zip file (typing cd {foldername} navigates folders, so, for example, cd C:\Python27 will change your command prompt to the folder C:\Python27)
  5. Type C:\Python27\ArcGIS10.4\python .\user_setup.py - replace ArcGIS10.4 with the folder name noted previously and Hit Enter to execute the command.
  6. The code is now installed. To use the tools, you'll need to add the toolbox named wq-processing-toolbox.pyt and located in the folder you extracted the zip file to ArcMap. You can safely move the whole extracted folder to somewhere more permanent where you can access the toolbox in the future.

Basic Setup - ArcGIS Pro

  1. Download the installation package with the arcproject code, and extract the zip file to a folder on your computer.
  2. Inside that folder will be a file, called a "wheel" and named something like arcproject-wq*.whl where * indicates version information and other information you can ignore for now.
  3. Open a command prompt as an administrator and navigate to the folder where you extracted the zip file (with the wheel file in it)
  4. Type C:\Program Files\ArcGIS\Pro\bin\Python\scripts\propy.bat -m pip install .\WHEEL_FILE.whl - replace WHEEL_FILE.whl with the name of the wheel file from the first step (for example arcproject_wq-0.9-py2.py3-none-any.whl). Note that on windows, in the command prompt, if you type .\arcproject and then hit the Tab key on the keyboard, it will autocomplete names for you so you don't have to type the full name in.
  5. The code is now installed. To use the tools, you'll need to add the toolbox (wq-processing-toolbox.pyt) to ArcGIS Pro.

Upgrading to a newer version

If you receive a newer version of the installation package, just follow the installation instructions again to upgrade the software. Make sure that you readd the toolbox using the new version in the new location you extracted the software to.

Advanced Setup

If you would like to do optional advanced setup methods to isolate the ArcProject code, see the following. These methods supercede the methods on this page and should be done instead of these methods, not in addition to.

Clone this wiki locally