Skip to content

Commit

Permalink
docs: update install instructions for pro 3.3
Browse files Browse the repository at this point in the history
  • Loading branch information
agrc-dev committed May 10, 2024
1 parent 86490f3 commit 9994e71
Showing 1 changed file with 23 additions and 26 deletions.
49 changes: 23 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,30 @@ This is an effort to polish/standardize/automate a mishmash of stand-alone pytho

## Installation

**not required for data-update command only installation*
\*_not required for data-update command only installation_

1. Install ArcGIS Pro (Standard license level or higher)
1. Create new python 3.9 conda environment and activate
1. `conda create --name honeycomb python=3.9`
1. Install [`gcloud`](https://cloud.google.com/sdk/docs/)*
- Do _not_ include the bundled python.
1. Install compiled crcmod (couldn't get this to work) (crcmod compiled version is [only available for 32bit python on windows](https://cloud.google.com/storage/docs/gsutil_install#:~:text=If%20you%20plan%20to%20use%20composite%20objects%2C%20you%20need%20to%20install%20compiled%20crcmod.%20On%20Windows%2C%20this%20is%20only%20available%20for%2032%2Dbit%20Python.))*
1. Create new python conda environment and activate
1. `conda create --name honeycomb python=3.11`
1. `conda install arcpy -c esri`
1. Clone repository to local folder.
1. From project folder base:
`pip install -e . --upgrade`
`pip install -e . --upgrade`
1. From forklift folder (`C:\dev\forklift`):
`pip install . --upgrade`
`pip install . --upgrade`
1. Add the following environmental variables:

| Name | Description | Example |
| --- | --- | --- |
| `HONEYCOMB_SHARE` | the to the share folder used to share mxd's and data with Zach | \\999.99.99.99\agrc\caching |
| `HONEYCOMB_SENDGRID_API_KEY` | your sendgrid api key | SG.1234567890 |
| `HONEYCOMB_AGS_SERVER`* | your ArcGIS server url | <http://localhost:6080/arcgis/admin> |
| `HONEYCOMB_AGS_USERNAME`* | your ArcGIS Server username | name |
| `HONEYCOMB_AGS_PASSWORD`* | your ArcGIS Server password | password |
| `HONEYCOMB_GIZA_USERNAME`* | your Giza (discover) username | name |
| `HONEYCOMB_GIZA_PASSWORD`* | your Giza (discover) password | password |
| `HONEYCOMB_AGOL_USERNAME`* | your AGOL username | name |
| `HONEYCOMB_AGOL_PASSWORD`* | your AGOL password | password |
| Name | Description | Example |
| ---------------------------- | -------------------------------------------------------------- | ------------------------------------ |
| `HONEYCOMB_SHARE` | the to the share folder used to share mxd's and data with Zach | \\999.99.99.99\agrc\caching |
| `HONEYCOMB_SENDGRID_API_KEY` | your sendgrid api key | SG.1234567890 |
| `HONEYCOMB_AGS_SERVER`\* | your ArcGIS server url | <http://localhost:6080/arcgis/admin> |
| `HONEYCOMB_AGS_USERNAME`\* | your ArcGIS Server username | name |
| `HONEYCOMB_AGS_PASSWORD`\* | your ArcGIS Server password | password |
| `HONEYCOMB_GIZA_USERNAME`\* | your Giza (discover) username | name |
| `HONEYCOMB_GIZA_PASSWORD`\* | your Giza (discover) password | password |
| `HONEYCOMB_AGOL_USERNAME`\* | your AGOL username | name |
| `HONEYCOMB_AGOL_PASSWORD`\* | your AGOL password | password |

1. Run `honeycomb config open`. This will initialize your config with default values and open it in your text editor.
1. Set map services to be dedicated instances with a min of 0 to prevent schema locks when updating the data.
Expand All @@ -55,13 +52,13 @@ Note: in order for honeycomb to modify files in the arcgis server cache director

Run `honeycomb config open` to open the config file.

| Property | Description |
| --- | --- |
| `basemaps` | Object defining the registered base maps. Use the cli to manage this list.
| `configuration` | Affects a few code paths for differences between production and development. Possible values: `prod` and `dev` (default).
| `notify` | A list of email addresses to whom honeycomb sends status updates.
| `sendEmails` | A boolean that determines whether emails are actually sent or not. Useful during development.
| `num_processes` | A number that indicates the maximum number of parallel processes to use when uploading files to GCP.
| Property | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `basemaps` | Object defining the registered base maps. Use the cli to manage this list. |
| `configuration` | Affects a few code paths for differences between production and development. Possible values: `prod` and `dev` (default). |
| `notify` | A list of email addresses to whom honeycomb sends status updates. |
| `sendEmails` | A boolean that determines whether emails are actually sent or not. Useful during development. |
| `num_processes` | A number that indicates the maximum number of parallel processes to use when uploading files to GCP. |

## Adding a New Layer

Expand Down

0 comments on commit 9994e71

Please sign in to comment.