Skip to content

Commit

Permalink
Merge pull request #626 from Esri/dev
Browse files Browse the repository at this point in the history 
Merge for September 2017 release
  • Loading branch information
@csmoore
csmoore committed Sep 28, 2017
2 parents de6b175 + e9f4ca2 commit d37fb1f
Show file tree
Hide file tree
Showing 1,556 changed files with 19,128 additions and 33,032 deletions.
6 changes: 4 additions & 2 deletions .gitignore
View file
@@ -1,6 +1,4 @@
# Defense Template specific ignores
application/
data/
maps/
scratch/
log/
Expand All @@ -15,6 +13,10 @@ arc.dir
*-sav.*
*Copy.*
*.log
*.sav
*.pyproj
*.sln
log*.txt

#############
## Python
Expand Down
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Expand Up @@ -49,6 +49,26 @@ The following guides are *strongly* suggested and encouraged:

And of course [PEP20 - The Zen of Python](https://www.python.org/dev/peps/pep-0020/)

Also make sure that new toolboxes follow the organizational structure of geoprocessing tools. Most of the toolboxes (whether .TBX or .PYT) usually contain other stuff that they use to work. This could be a .LYR for rendering output, or a geodatabase look-up table as an input. To make sure that the tool can easily and consistently find the associated data and files we use a specific folder organization. It looks like this:

* **[toolboxes]** - highest level folder
* mytools_arcmap.tbx - example toolbox
* othertools_pro.pyt - example toolbox
* **[scripts]** - folder containing .PY or other script files needed by the toolbox
* somescript1.py - example script file
* somescript2.py - example script file
* otherscript.py - example script file
* **[layers]** - all of those .LYR or .LYRX files used in drawing tool results go here
* somescript1output.lyr - example layer file
* otherscriptoutput.lyr - example layer file
* **[tooldata]** - this folder contains any *data* used by the tools. This could be file geodatabases, Microsoft Excel spreadsheets, TXT files, Shapefiles, .JSON bits, etc., but no test/sample data. See notes below.
* [mytools.gdb] - example file geodatabase

A few things to keep in mind:

* The folder names, eg. "toolboxes", "scripts", "layers", "tooldata", are specific and are intentionally kept lowercase with no spaces or underscores.
* The "tooldata" folder **MUST NOT** contain test data or sample data. It is ONLY for data that the tool requires to operate. Sample data and test data go somewhere else.

### Share Your Mods
If you've made changes to the repo that you want to share with the community.

Expand Down
149 changes: 82 additions & 67 deletions README.md
View file
@@ -1,9 +1,7 @@

# solutions-geoprocessing-toolbox

The ArcGIS Solutions Geoprocessing Toolbox is a collection of models, scripts, and tools for use in [ArcGIS for Desktop](http://www.esri.com/software/arcgis/arcgis-for-desktop) and [ArcGIS Pro](http://www.esri.com/en/software/arcgis-pro). These tools provide specialized processing, workflows, and analysis for defense, intelligence, emergency management, and other solutions domains. With these tools you can determine visibility from a specific viewpoint, create search grids, and analyze event data. They are included with many of Esri's [Solutions Templates](http://solutions.arcgis.com/), but developers can use this repository to download and contribute to the tool development process.

![Image of the toolbox](./img/solutions-geoprocessing-toolbox_screenshot_14APR2016_824x400.png)
The ArcGIS Solutions Geoprocessing Toolbox is a collection of models, scripts, and tools for use in [ArcGIS for Desktop](http://www.esri.com/software/arcgis/arcgis-for-desktop) and [ArcGIS Pro](http://www.esri.com/en/software/arcgis-pro). These tools provide specialized processing, workflows, and analysis for defense, intelligence, emergency management, and law enforcement. They are included in Esri's [Solutions Templates](http://solutions.arcgis.com/).


### Repository Owner: [Matt](https://github.com/mfunk)
Expand All @@ -27,79 +25,95 @@ Additional information is available in the repository's [Wiki](https://github.co
* [Instructions To Get Started](#instructions-to-get-started)
* [General Help](#general-help)
* [Getting Started with the tools](#getting-started-with-the-tools)
* [Downloading Test Data](#downloading-test-data)
* [Running Verification Tests](#running-verification-tests)
* [Mature Support](#mature-support)
* [Resources](#resources)
* [Issues](#issues)
* [Contributing](#contributing)
* [Credits](#credits)
* [Licensing](#licensing)

## Features

Specialized geoprocessing models and tools for general defense and intelligence analysis tasks including:

* The [**capability**](./capability/README.md) folder contains:
* ERG (Emergency Resources Guide) Tools
* Helicopter Landing Zone Tools
* Point Of Origin Tools -- [This tool is moving to Mature Support](#mature-support)

* The [**data_management**](./data_management/README.md) folder contains:
* Adjust Sample Data Dates Tools
* CADRG ECRG Tools -- [This tool is moving to Mature Support](#mature-support)
* CIB Tools -- [This tool is moving to Mature Support](#mature-support)
* Elevation Tools -- [This tool is moving to Mature Support](#mature-support)
* Geonames Tools
* Import and Conversion Tools - formerly Position Analysis Tools -- [This tool is moving to Mature Support](#mature-support)
* LiDAR Elevation Tools
* Network Data Preparation Tools -- [This tool is moving to Mature Support](#mature-support)
* Patrol Data Capture Tools -- [This tool is moving to Mature Support](#mature-support)
* Publishable Task Tools -- [This tool is moving to Mature Support](#mature-support)

* The [**operational_graphics**](./operational_graphics/README.md) folder contains:
* Clearing Operations Tools
* Range Card Tools -- [This tool is moving to Mature Support](#mature-support)

* The [**patterns**](./patterns/README.md) folder contains:
* Incident Analysis Tools
* Movement Analysis Tools

* The [**suitability**](./suitability/README.md) folder contains:
* Maritime Decision Aid Tools
* Military Aspects of Terrain Tools
* Military Aspects of Weather Tools
* Path Slope Tools
* The [**geonames**](./geonames) folder contains:
* Geonames Tools_pro
* Geonames Tools_arcmap
* [Geonames Locator Solutions Page](http://solutions.arcgis.com/defense/help/geonames-locator/)

* The [**visibility**](./visibility/README.md) folder contains:
* Sun Position Analysis Tools
* Visibility and Range Tools
* Visibility Data Prep Tools
* The [**clearing_operations**](./clearing_operations) folder contains:
* Clearing Operations Tools_pro
* Clearing Operations Tools_arcmap
* [Clearing Operations Solutions Page](http://solutions.arcgis.com/defense/help/clearing-operations/)

* The [**distance_to_assets**](./distance_to_assets) folder contains:
* Distance To Assets_pro
* Distance To Assets_arcmap
* [Distance to Assets Solutions Page](http://solutions.arcgis.com/defense/help/distance-to-assets/)

* The [**military_aspects_of_terrain**](./military_aspects_of_terrain) folder contains:
* Military Aspects of Terrain Tools_pro
* Military Aspects of Terrain Tools_arcmap
* [Military Aspects of Terrain Solutions Page](http://solutions.arcgis.com/defense/help/maot/)

* The [**military_aspects_of_weather**](./military_aspects_of_weather) folder contains:
* Military Aspects of Weather Tools_arcmap
* [Military Aspects of Weather Solutions Page](http://solutions.arcgis.com/defense/help/maow/)

* The [**military_features**](./military_features) folder contains:
* Military Features Tools_arcmap
* [Military Features Solutions Page](http://solutions.arcgis.com/defense/help/military-features/)

* The [**sun_position_analysis**](./sun_position_analysis) folder contains:
* Sun Position Analysis Tools_pro
* Sun Position Analysis Tools_arcmap
* [Sun Position Analysis Solutions Page](http://solutions.arcgis.com/defense/help/sun-position-analysis/)

* The [**incident_analysis**](./incident_analysis) folder contains:
* Incident Analysis Tools_pro
* Adjust Sample Data Dates Tools_pro
* Incident Analysis Tools_arcmap
* Adjust Sample Data Dates Tools_arcmap
* [Incident Analysis Solutions Page](http://solutions.arcgis.com/defense/help/incident-analysis/)

## Requirements

* ArcGIS Desktop 10.4+ or ArcGIS Pro 1.1+
* Check [Releases](https://github.com/Esri/solutions-geoprocessing-toolbox/releases) for tools for previous versions of ArcGIS Desktop
* Some tools require additional licenses (these tools will be disabled if license is unavailable), see READMEs for more information:
* ArcGIS Desktop Advanced (ArcInfo)
* ArcGIS Desktop 10.3.1 (or later)
* ArcGIS Pro 1.4 (or later)

NOTE: Check [Releases](https://github.com/Esri/solutions-geoprocessing-toolbox/releases) for tools for previous versions of ArcGIS Desktop

* Some tools require additional licenses (these tools will be disabled if license is unavailable):
* ArcGIS Desktop Advanced
* Clearing Operations_arcmap
* Clearing Operations_pro
* Military Features Tools_arcmap
* ArcGIS Spatial Analyst Extension
* Military Aspects of Terrain_pro
* Military Aspects of Terrain_arcmap
* Sun Position Analysis Tools_pro
* Sun Position Analysis Tools_arcmap
* ArcGIS 3D Analyst Extension
* ArcGIS Network Analyst Extension
* For example these tools require Desktop Advanced and Spatial Analyst:
* Path Slope Tools.tbx\Path Slope
* Visibility and Range Tools.tbx\Range Fan
* Military Aspects of Terrain_pro
* Military Aspects of Terrain_arcmap
* Access to ArcGIS Organization Account
* Distance To Assets_pro
* Distance To Assets_arcmap

## A Tale of Two Toolboxes

The solutions-geoprocessing-toolbox repo is now supporting toolboxes for both ArcMap/ArcCatalog/ArcGlobe/ArcScene (collectively called ArcGIS for Desktop) and also ArcGIS Pro. Toolboxes that are modified in ArcGIS Pro are not
backwards compatible with other ArcGIS Desktop applications (ArcMap), so most toolboxes are duplicated for one or the other. The naming of these toolboxes is as follows:
The solutions-geoprocessing-toolbox repo supports toolboxes for both ArcMap/ArcCatalog/ArcGlobe/ArcScene (collectively called ArcGIS for Desktop) and also ArcGIS Pro. Toolboxes that are modified in ArcGIS Pro are not
backwards compatible (see **Compatibility** note below) with other ArcGIS Desktop applications (ArcMap), so most toolboxes are duplicated for one or the other. The naming of these toolboxes is as follows:

* Toolboxes that are for ArcGIS Desktop will include *arcmap* after the toolbox name. For example: **Geonames Tools__arcmap.tbx**
* Toolboxes for ArcGIS Pro will include *pro*. For example: **Geonames Tools__pro.tbx**

* Toolboxes that are for ArcGIS Desktop 10.4 will include *_10.4* after the toolbox name. For example: **Visibility and Range Tools_10.4.tbx**
* Toolboxes with a 'unversioned' name are for ArcGIS Pro 1.1. For example: **Visibility and Range Tools.tbx**

Please note that some toolboxes are for ArcGIS Pro only, or ArcGIS Desktop only. These toolboxes will follow the above naming convention, but will not have a duplicate.

Please note that some toolboxes are for ArcGIS Pro only, or ArcGIS Desktop 10.4 only. These toolboxes will follow the above naming convention, but will not have a duplicate.
Also note that some of our toolboxes are (Python Toolboxes)[http://desktop.arcgis.com/en/arcmap/latest/analyze/creating-tools/a-quick-tour-of-python-toolboxes.htm] (.pyt) and work in both ArcMap and ArcGIS Pro. These do not have the _arcmap_ or _pro_ suffix.

* [Compatibility: ModelBuilder migration in Pro](http://pro.arcgis.com/en/pro-app/help/analysis/geoprocessing/modelbuilder/modelbuilder-changes-in-arcgis-pro.htm)
* [Product info for ArcGIS Pro](http://www.esri.com/software/arcgis-pro)
* [Help for ArcGIS Pro](http://pro.arcgis.com/en/pro-app/)

Expand All @@ -116,17 +130,13 @@ Please note that some toolboxes are for ArcGIS Pro only, or ArcGIS Desktop 10.4
* Download the Github repository
* If repository was downloaded as a zip, extract the zip file
* Make note of this directory, the steps below assume it will be called "solutions-geoprocessing-toolbox"
* Open the toolboxes in the appropriate version of ArcMap or ArcGIS Pro listed in [requirements](#requirements).
* Questions about the tools? Start by reading the tool doc.
* Open the toolboxes in the appropriate version of ArcMap or ArcGIS Pro listed in [requirements](#requirements)
* Questions about the tools? Start by reading the tool doc
* Tool doc doesn't make sense? Please log an [issue](https://github.com/Esri/solutions-geoprocessing-toolbox/issues) and let us know!

### Downloading Test Data

**This section is under reconstruction, per issue [#371](https://github.com/Esri/solutions-geoprocessing-toolbox/issues/371)**

### Running Verification Tests

- Follow instructions in [Running tests for solutions-geoprocessing-toolbox](.utils/test/Readme.md)
- Follow instructions in [Running tests for solutions-geoprocessing-toolbox](./utils/test/Readme.md)

## Mature Support
For information Esri support levels visit the [Esri Product Life Cycle](http://support.esri.com/other-resources/product-life-cycle) page. Toolboxes marked for Mature Support will be removed from this repository's *dev* and *master* branches in the future, but will still be availalbe from earlier [releases](https://github.com/Esri/solutions-geoprocessing-toolbox/releases).
Expand All @@ -150,19 +160,27 @@ To submit an issue:
3. Fill out *all* of the relevant sections
4. **Submit new issue** when completed

Tips:
* Include a FULL description of the problem or enhancement or idea. Include:
* What happened (details)?
* What did you expect to happen?
* What is different between what happened and what you expected?
* What versions of the software are you working on?
* Include the text of any error messages.
* Include steps to reproduce the problem. We can't solve it if we can't see what's wrong.
* Use a numbered list of steps.
* DETAILS: Be explicit. More is better, than little, which is better than nothing. Never assume we know what you're talking about (assume we don't know).
* Include screenshots to support the info above, but NEVER replace a good description with a screenshot.

## Contributing

When you contribute to this repository we ask that you follow the guidelines in the [repository-specific guidelines for contributing](./CONTRIBUTING.md). If you have questions, or you get stuck, please ask the [Repository Owner](#repository-owner). We are here to help! Thanks.

Esri welcomes contributions from anyone and everyone through GitHub. Please see Esri's general [guidelines for contributing](https://github.com/esri/contributing).


## Credits
Mosaic Dataset Configuration Scripts (MDCS) is an Esri repo available at [https://github.com/Esri/mdcs-py](https://github.com/Esri/mdcs-py) and [licensed](https://github.com/Esri/mdcs-py/blob/master/license.txt) under Apache License Version 2.0, January 2004.

## Licensing

Copyright 2016 Esri
Copyright 2016-2017 Esri

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -178,6 +196,3 @@ limitations under the License.

A copy of the license is available in the repository's
[license.txt](license.txt) file.

[](Esri Tags: ArcGIS Defense and Intelligence Military Emergency Management National Security)
[](Esri Language: Python)
67 changes: 0 additions & 67 deletions capability/README.md
View file

This file was deleted.

Binary file removed capability/capability_screenshot.jpg
View file
Binary file not shown.

0 comments on commit d37fb1f

Please sign in to comment.