SBAS/UsersGuide: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
mNo edit summary
(Adding additional sub-sections to the Installation Instructions section - Alternative attributes list and descriptions)
Line 24: Line 24:


==SBAS ArcGIS Pro==
==SBAS ArcGIS Pro==
===Installation===
===Installation Instructions===
[[File:SBAS2020Toolbox.png|thumb|right|Figure 1: SBAS 2020 Toolbox installed and viewed in the Catalog pane]]
*Installation for SBAS for ArcGIS Pro is as simple as unzipping the distribution file to a local drive.  The zip file includes the toolbar (SBAS_2020.pyt), layer packages (*.lyrx), a settings file (SBAS_settings.txt), and a template geodatabase (SBAS.gdb).
*Installation for SBAS for ArcGIS Pro is as simple as unzipping the distribution file to a local drive.  The zip file includes the toolbar (SBAS_2020.pyt), layer packages (*.lyrx), a settings file (SBAS_settings.txt), and a template geodatabase (SBAS.gdb).
*To launch the SBAS tools, create a new project in ArcGIS Pro.  In order to access the contents of the SBAS tool, be sure to Add a Folder Connection to your project in the Catalog pane.
*To launch the SBAS tools, create a new project in ArcGIS Pro.  In order to access the contents of the SBAS tool, be sure to Add a Folder Connection to your project in the Catalog pane.
*The SBAS ArcGIS Pro Toolbox
*The SBAS ArcGIS Pro Toolbox
**SBAS for ArcGIS Pro is designed as an ArcToolbox written in Python. Browsing to the file SBAS_2020.pyt in the Catalog pane, will expand to show the individual tools included in the toolbox.
::*SBAS for ArcGIS Pro is designed as an ArcToolbox written in Python. Browsing to the file SBAS_2020.pyt in the Catalog pane, will expand to show the individual tools included in the toolbox (Figure 1).
[[File:SBAS2020Toolbox.png|thumb|right]]
::*The toolbox reads a settings file, SBAS_settings.txt, that MUST side in the the same directory as the pyt file. This file is used but the different SBAS tools to easily find the designated local SBAS database.


===Local and Enterprise Data Storage===
===Local and Enterprise Data Storage===
====Local Database Location====
SBAS uses the template database (SBAS.gdb) to storage all sediment budge geometries and alternative values.  This local geodatabase contains 5 objects.  The database schema follows the schema identified by SDSFIE.
:'''Alternative''' is a table that holds basic metadata information related to individual sediment budgets.
:*''scenarioIDPK'' (text, 50 characters).  Primary Key. This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario).
:*''sdsID'' (guid). This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario).  Value can be used to link to items in other enterprise GIS.
:*''scenarioAuthor'' (text, 100 characters). Author of the alternative.  Name of author is pre-determined by the user login to ArcGIS Pro.  Name is listed as the ArcGIS Online username.
:*''sdsFeatureName'' (text, 50 characters). Name or label of alternative.
:*''sdsFeatureDescription'' (text, 255 characters). Description of alternative.
:*''geoAreaDescription'' (text, 255 characters). Description of location of sediment budget
:*''projectID'' (text, 50 characters). Optional project id for internal management purposes. The SBAS application does not reference or write to this field.
:*''dateScenarioCreated'' (date). Data alternative created in teh SBAS database.
:*''budgetType'' (text, 50 characters). Type of sediment budget (Micro - local or Macro - regional).
:*''dateIntervalStart'' (date). Start date of alternative epoch.
:*''dateIntervalEnd'' (date). End date of alternative epoch.
:*''cellUnits'' (text, 255 characters). Units of volume for litttoral cells (Cubic Yards or Cubic Meters)
:*''qUnits'' (text, 255 characters). Units of volume for sediment transport rate (Cupic Yards/Year or Cubic Meters/Year)
:*''uncertaintyMethods'' (text, 50 characters). List of uncertainty methods used in Sediment Budget. The SBAS application does not reference or write to this field.
:*''medialDPK'' (text, 50 characters). ID to hold links to related media documentation. The SBAS application does not reference or write to this field.
:*''sdsMetadataID'' (text, 50 characters). ID to hold unique metadata ID.
:'''Sediment Management Cells'''
:*Content
====Enterprise Database Location====
===Creating a Sediment Budget===
===Creating a Sediment Budget===
==GenCade/SBAS Compatibility==


==SBAS ArcGIS Desktop==
==SBAS ArcGIS Desktop==

Revision as of 15:17, 15 July 2020

__NOTITLE__

SBAS User's Guide

Versions & Requirements

  • SBAS ArcGIS Pro
  • SBAS ArcGIS Desktop
Requires ArcGIS 10.1 - 10.4
Python comtypes package (tested with 0.6.2 - included with this tool)
Author: Thomas Heller, theller@ctypes.org
License: MIT License
The package must be installed into the local python instance.
Install does not require admin rights.
Can be installed by running comtypes-0.6.2\install_comtypes.bat
Snippets.py, slightly modified code snippets file for accessing ArcObjects via Python. (Included)
  • File: snippets.py -- (Previous link http://www.pierssen.com/arcgis/misc.htm no longer works)
Author: Mark Cederholm
License: No specific license.
(Formerly available on http://www.pierssen.com/ and indicated "Free stuff for GIS Developers and Users!")
  • SBAS Desktop

SBAS ArcGIS Pro

Installation Instructions

Figure 1: SBAS 2020 Toolbox installed and viewed in the Catalog pane
  • Installation for SBAS for ArcGIS Pro is as simple as unzipping the distribution file to a local drive. The zip file includes the toolbar (SBAS_2020.pyt), layer packages (*.lyrx), a settings file (SBAS_settings.txt), and a template geodatabase (SBAS.gdb).
  • To launch the SBAS tools, create a new project in ArcGIS Pro. In order to access the contents of the SBAS tool, be sure to Add a Folder Connection to your project in the Catalog pane.
  • The SBAS ArcGIS Pro Toolbox
  • SBAS for ArcGIS Pro is designed as an ArcToolbox written in Python. Browsing to the file SBAS_2020.pyt in the Catalog pane, will expand to show the individual tools included in the toolbox (Figure 1).
  • The toolbox reads a settings file, SBAS_settings.txt, that MUST side in the the same directory as the pyt file. This file is used but the different SBAS tools to easily find the designated local SBAS database.

Local and Enterprise Data Storage

Local Database Location

SBAS uses the template database (SBAS.gdb) to storage all sediment budge geometries and alternative values. This local geodatabase contains 5 objects. The database schema follows the schema identified by SDSFIE.

Alternative is a table that holds basic metadata information related to individual sediment budgets.
  • scenarioIDPK (text, 50 characters). Primary Key. This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario).
  • sdsID (guid). This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario). Value can be used to link to items in other enterprise GIS.
  • scenarioAuthor (text, 100 characters). Author of the alternative. Name of author is pre-determined by the user login to ArcGIS Pro. Name is listed as the ArcGIS Online username.
  • sdsFeatureName (text, 50 characters). Name or label of alternative.
  • sdsFeatureDescription (text, 255 characters). Description of alternative.
  • geoAreaDescription (text, 255 characters). Description of location of sediment budget
  • projectID (text, 50 characters). Optional project id for internal management purposes. The SBAS application does not reference or write to this field.
  • dateScenarioCreated (date). Data alternative created in teh SBAS database.
  • budgetType (text, 50 characters). Type of sediment budget (Micro - local or Macro - regional).
  • dateIntervalStart (date). Start date of alternative epoch.
  • dateIntervalEnd (date). End date of alternative epoch.
  • cellUnits (text, 255 characters). Units of volume for litttoral cells (Cubic Yards or Cubic Meters)
  • qUnits (text, 255 characters). Units of volume for sediment transport rate (Cupic Yards/Year or Cubic Meters/Year)
  • uncertaintyMethods (text, 50 characters). List of uncertainty methods used in Sediment Budget. The SBAS application does not reference or write to this field.
  • medialDPK (text, 50 characters). ID to hold links to related media documentation. The SBAS application does not reference or write to this field.
  • sdsMetadataID (text, 50 characters). ID to hold unique metadata ID.
Sediment Management Cells
  • Content

Enterprise Database Location

Creating a Sediment Budget

GenCade/SBAS Compatibility

SBAS ArcGIS Desktop

Installation

  1. Download SBASArc10 Toolbox Here
  2. Extract ZIP distribution
  3. Move SBAS directory to one's desired location
  4. Run SBAS\comtypes-0.6.2\install_comtypes.bat
  5. Run SBAS\install_dependencies.bat
  6. Within the Catalog, add a Folder Connection to the SBAS directory
  7. Within the Folder Connection to the SBAS toolbox, expand the toolbox and execute the "00 - Set Up SBAS Environment" tool.

Usage

  • If you would like to specify a workspace path and/or load a basemap, run the "00 - Set Up Environment" tool before running any other tools on your map document.
  • For the remainder of the workflow, tools should be executed essentially in order. For example, one must execute "01a - Create SBAS Alternative" before executing "01b - Load SBAS Alternative", which must be run before executing "02a - Convert Graphics to New Features".

Points of Contact

Main POC: Eve Eisemann
Email: Eve.Eisemann@usace.army.mil

Secondary POC: Katie Brutsche
Email: Katherine.E.Brutsche@usace.army.mil

Technical Issues: Rose Dopsovic
Email: Rose.Dopsovic@usace.army.mil


Back to Main SBAS Page

Retrieved from "https://cirpwiki.info/index.php?title=SBAS/UsersGuide&oldid=12896"