From b3127870b305000c4904375b263fe9eab0e553af Mon Sep 17 00:00:00 2001 From: Lachlan Hurst Date: Thu, 7 Sep 2023 14:34:29 +1000 Subject: [PATCH] refactored readme to clear up installation process for different ArcGIS Pro versions Docs in main branch now apply to all release versions, as asking the user to change branch to view relevant docs was probably a 'bit much'. --- README.md | 64 +++--------------------------------- docs/install_arcgispro_29.md | 50 ++++++++++++++++++++++++++++ docs/install_arcgispro_30.md | 54 ++++++++++++++++++++++++++++++ docs/install_arcgispro_31.md | 54 ++++++++++++++++++++++++++++++ 4 files changed, 163 insertions(+), 59 deletions(-) create mode 100644 docs/install_arcgispro_29.md create mode 100644 docs/install_arcgispro_30.md create mode 100644 docs/install_arcgispro_31.md diff --git a/README.md b/README.md index 16ccd36bb..9220147d2 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,8 @@ The Tenement Tools ArcGIS Pro plug-in is now version 1.0 and has been released!
-> **Warning** -> The following requirements and setup instructions apply only to **ArcGIS Pro 3.0** (information for ArcGIS Pro 2.8 and 2.9 can be found [here](https://github.com/frontiersi/tenement-tools/blob/main/README.md)) - ## Requirements -* ArcGIS Pro version 3.0 +* ArcGIS Pro version 2.8, 2.9, 3.0, or 3.1 * At least 8gb of ram (>=16gb recommended) * Fast and stable internet connection with unlimited download capacity (imagery downloads are large!) * Access to the following websites (IT may need to exclude from firewall): @@ -21,61 +18,10 @@ The Tenement Tools ArcGIS Pro plug-in is now version 1.0 and has been released!
## Setup -The Tenement Tools setup process can take up to 30 minutes. Please follow the below steps to install. - -### 1. Download Tenement Tools plug-in and tutorial material -Download the tenement-tools.zip, tutorial.zip and tutorial.pdf files from the latest release located here: -- https://github.com/frontiersi/tenement-tools/releases. - -> **Note** -> Please download a release that is stated as being compatible with ArcGIS Pro 3.0 - -### 2. Extract tenement-tools folder -Extract the tenement-tools folder from the tenement-tools.zip and store it somewhere permanent. -- Recommended location: C:/Users/%USERNAME%/Documents/ArcGIS/tenement-tools - -### 3. Clone default ArcGIS Pro python environment -Tenement Tools requires a custom Python virtual environment. Luckily, ArcGIS Pro makes this easy: -1. Open Windows Start Menu > ArcGIS folder > Python Command Prompt -2. Enter and run conda create --clone arcgispro-py3 --name arcgispro-py3-dev-tool -3. When finished, enter and run: activate arcgispro-py3-dev-tool - -### 4. Install additional Python libraries -Additional Python libraries are defined within a conda environment file. This file can be downloaded -from the following link. -[https://raw.githubusercontent.com/frontiersi/tenement-tools/argispro30-migration/arc/envs/acrgispro3-py3.yml](https://raw.githubusercontent.com/frontiersi/tenement-tools/argispro30-migration/arc/envs/acrgispro3-py3.yml) - -To download this file, first open the link, then right-click and save the file to a suitable location. - -Now, enter and run the following command. This assumes the environment file downloaded above was saved -to the active directory. Note: this command may take some time to complete. -- conda env update --file acrgispro3-py3.yml - -Close the Python Command Prompt when finished. - -### 5. Add the Tenement Tools plug-in to ArcGIS Pro -Now, add the actual plug-in to ArcGIS Pro: -- Run ArcGIS Pro > Add-In Manager > Options tab > Add Folder > Select extracted tenement-tools folder (from step 2) - -Note: you may need to click "Load all Add-Ins without restrictions" option. - -### 6. Initialise the new python environment in ArcGIS Pro -Change ArcGIS Pro software to use the custom Python environment (from step 4): -- Run ArcGIS Pro > Package Manager > cog icon next to 'Active Environment' (Environment Manager) > Add folder icon (open existing environment) > Select folder arcgispro-py3-dev-tool env was created in > OK - -Restart ArcGIS Pro. - -### 7. Create new ArcGIS Pro project and add Tenement Tools Toolbox -Create a new ArcGIS Pro project for the tutorial: -- New > Map - -Finally, add the Tenement Tools toolbox to the project: -- In Catalog Pane > right-click Toolboxes icon > Add Toolbox > go to extracted folder (step 2) > toolbox folder > add tenement-tools-toolbox.pyt - -### 8. Walkthrough the tutorial pdf -A good place to start is with the Tutorial.pdf document downloaded in step 1. - -
+Please choose the correct installation process for your version of ArcGIS Pro, the version number can be found in the 'Help -> About' menu within ArcGIS Pro. +- [Installation for ArcGIS Pro 2.8 and 2.9](./docs/install_arcgispro_29.md) +- [Installation for ArcGIS Pro 3.0](./docs/install_arcgispro_30.md) +- [Installation for ArcGIS Pro 3.1](./docs/install_arcgispro_31.md) ## Updating to new version Version 1.0 has now been released! Any prior installations versions must be discarded and all steps above must be done again. diff --git a/docs/install_arcgispro_29.md b/docs/install_arcgispro_29.md new file mode 100644 index 000000000..11655f58c --- /dev/null +++ b/docs/install_arcgispro_29.md @@ -0,0 +1,50 @@ +## Setup for ArcGIS Pro v2.8 and v2.9 +The Tenement Tools setup process can take up to 30 minutes. Please follow the below steps to install. + +### 1. Download Tenement Tools plug-in and tutorial material +Download the tenement-tools.zip, tutorial.zip and tutorial.pdf files from the latest release located here: +- https://github.com/frontiersi/tenement-tools/releases. + +### 2. Extract tenement-tools folder +Extract the tenement-tools folder from the tenement-tools.zip and store it somewhere permanent. +- Recommended location: C:/Users/%USERNAME%/Documents/ArcGIS/tenement-tools + +### 3. Clone default ArcGIS Pro python environment +Tenement Tools requires a custom Python virtual environment. Luckily, ArcGIS Pro makes this easy: +1. Open Windows Start Menu > ArcGIS folder > Python Command Prompt +2. Enter and run conda create --clone arcgispro-py3 --name arcgispro29-py3-dev-tool +3. When finished, enter and run: activate arcgispro29-py3-dev-tool + +### 4. Install addtional Python libraries +Now, enter and run each of the below in order (enter 'y' if asked at end of each): +- conda install dask=2.30.0 +- conda install -c conda-forge rasterio==1.1.5 +- conda install -c conda-forge pyproj==2.6.1.post1 +- conda install -c conda-forge scikit-learn==1.0 +- conda install -c conda-forge odc-stac==0.2.2 +- conda install -c conda-forge datacube==1.8.6 +- pip install pystac-client==0.3.0 + +Close the Python Command Prompt when finished. + +### 5. Add the Tenement Tools plug-in to ArcGIS Pro +Now, add the actual plug-in to ArcGIS Pro: +- Run ArcGIS Pro > Add-In Manager > Options tab > Add Folder > Select extracted tenement-tools folder (from step 2) + +Note: you may need to click "Load all Add-Ins without restrictions" option. + +### 6. Initialise the new python environment in ArcGIS Pro +Change ArcGIS Pro software to use the custom Python environment (from step 4): +- Run ArcGIS Pro > Settings > Python > Manage Environments > Select arcgispro29-py3-dev-tool > OK + +Restart ArcGIS Pro. + +### 7. Create new ArcGIS Pro project and add Tenement Tools Toolbox +Create a new ArcGIS Pro project for the tutorial: +- New > Map + +Finally, add the Tenement Tools toolbox to the project: +- In Catalog Pane > right-click Toolboxes icon > Add Toolbox > go to extracted folder (step 2) > toolbox folder > add tenement-tools-toolbox.pyt + +### 8. Walkthrough the tutorial pdf +A good place to start is with the Tutorial.pdf document downloaded in step 1. diff --git a/docs/install_arcgispro_30.md b/docs/install_arcgispro_30.md new file mode 100644 index 000000000..11fdc814a --- /dev/null +++ b/docs/install_arcgispro_30.md @@ -0,0 +1,54 @@ +## Setup for ArcGIS Pro v3.0 +The Tenement Tools setup process can take up to 30 minutes. Please follow the below steps to install. + +### 1. Download Tenement Tools plug-in and tutorial material +Download the tenement-tools.zip, tutorial.zip and tutorial.pdf files from the latest release located here: +- https://github.com/frontiersi/tenement-tools/releases. + +> **Note** +> Please download a release that is stated as being compatible with ArcGIS Pro 3.0 + +### 2. Extract tenement-tools folder +Extract the tenement-tools folder from the tenement-tools.zip and store it somewhere permanent. +- Recommended location: C:/Users/%USERNAME%/Documents/ArcGIS/tenement-tools + +### 3. Clone default ArcGIS Pro python environment +Tenement Tools requires a custom Python virtual environment. Luckily, ArcGIS Pro makes this easy: +1. Open Windows Start Menu > ArcGIS folder > Python Command Prompt +2. Enter and run conda create --clone arcgispro-py3 --name arcgispro30-py3-dev-tool +3. When finished, enter and run: activate arcgispro30-py3-dev-tool + +### 4. Install additional Python libraries +Additional Python libraries are defined within a conda environment file. This file can be downloaded +from the following link. +[https://raw.githubusercontent.com/frontiersi/tenement-tools/arcgispro30/arc/envs/acrgispro.yml](https://raw.githubusercontent.com/frontiersi/tenement-tools/arcgispro30/arc/envs/acrgispro.yml) + +To download this file, first open the link, then right-click and save the file to a suitable location. + +Now, enter and run the following command. This assumes the environment file downloaded above was saved +to the active directory. Note: this command may take some time to complete. +- conda env update --file acrgispro.yml + +Close the Python Command Prompt when finished. + +### 5. Add the Tenement Tools plug-in to ArcGIS Pro +Now, add the actual plug-in to ArcGIS Pro: +- Run ArcGIS Pro > Add-In Manager > Options tab > Add Folder > Select extracted tenement-tools folder (from step 2) + +Note: you may need to click "Load all Add-Ins without restrictions" option. + +### 6. Initialise the new python environment in ArcGIS Pro +Change ArcGIS Pro software to use the custom Python environment (from step 4): +- Run ArcGIS Pro > Package Manager > cog icon next to 'Active Environment' (Environment Manager) > Add folder icon (open existing environment) > Select folder arcgispro30-py3-dev-tool env was created in > OK + +Restart ArcGIS Pro. + +### 7. Create new ArcGIS Pro project and add Tenement Tools Toolbox +Create a new ArcGIS Pro project for the tutorial: +- New > Map + +Finally, add the Tenement Tools toolbox to the project: +- In Catalog Pane > right-click Toolboxes icon > Add Toolbox > go to extracted folder (step 2) > toolbox folder > add tenement-tools-toolbox.pyt + +### 8. Walkthrough the tutorial pdf +A good place to start is with the Tutorial.pdf document downloaded in step 1. diff --git a/docs/install_arcgispro_31.md b/docs/install_arcgispro_31.md new file mode 100644 index 000000000..4172a86da --- /dev/null +++ b/docs/install_arcgispro_31.md @@ -0,0 +1,54 @@ +## Setup +The Tenement Tools setup process can take up to 30 minutes. Please follow the below steps to install. + +### 1. Download Tenement Tools plug-in and tutorial material +Download the tenement-tools.zip, tutorial.zip and tutorial.pdf files from the latest release located here: +- https://github.com/frontiersi/tenement-tools/releases. + +> **Note** +> Please download a release that is stated as being compatible with ArcGIS Pro 3.1 + +### 2. Extract tenement-tools folder +Extract the tenement-tools folder from the tenement-tools.zip and store it somewhere permanent. +- Recommended location: C:/Users/%USERNAME%/Documents/ArcGIS/tenement-tools + +### 3. Clone default ArcGIS Pro python environment +Tenement Tools requires a custom Python virtual environment. Luckily, ArcGIS Pro makes this easy: +1. Open Windows Start Menu > ArcGIS folder > Python Command Prompt +2. Enter and run conda create --clone arcgispro-py3 --name arcgispro-py3-dev-tool +3. When finished, enter and run: activate arcgispro-py3-dev-tool + +### 4. Install additional Python libraries +Additional Python libraries are defined within a conda environment file. This file can be downloaded +from the following link. +[https://raw.githubusercontent.com/frontiersi/tenement-tools/arcgispro31/arc/envs/acrgispro.yml](https://raw.githubusercontent.com/frontiersi/tenement-tools/arcgispro31/arc/envs/acrgispro.yml) + +To download this file, first open the link, then right-click and save the file to a suitable location. + +Now, enter and run the following command. This assumes the environment file downloaded above was saved +to the active directory. Note: this command may take some time to complete. +- conda env update --file acrgispro.yml + +Close the Python Command Prompt when finished. + +### 5. Add the Tenement Tools plug-in to ArcGIS Pro +Now, add the actual plug-in to ArcGIS Pro: +- Run ArcGIS Pro > Add-In Manager > Options tab > Add Folder > Select extracted tenement-tools folder (from step 2) + +Note: you may need to click "Load all Add-Ins without restrictions" option. + +### 6. Initialise the new python environment in ArcGIS Pro +Change ArcGIS Pro software to use the custom Python environment (from step 4): +- Run ArcGIS Pro > Package Manager > cog icon next to 'Active Environment' (Environment Manager) > Add folder icon (open existing environment) > Select folder arcgispro-py3-dev-tool env was created in > OK + +Restart ArcGIS Pro. + +### 7. Create new ArcGIS Pro project and add Tenement Tools Toolbox +Create a new ArcGIS Pro project for the tutorial: +- New > Map + +Finally, add the Tenement Tools toolbox to the project: +- In Catalog Pane > right-click Toolboxes icon > Add Toolbox > go to extracted folder (step 2) > toolbox folder > add tenement-tools-toolbox.pyt + +### 8. Walkthrough the tutorial pdf +A good place to start is with the Tutorial.pdf document downloaded in step 1.