owf-app-geoprocessor-python-doc-dev

This repository contains the Open Water Foundation (OWF) GeoProcessor software developer documentation.

See the latest deployed developer documentation.

See also the latest deployed user documentation.

The documentation is maintained as a separate repository to facilitate edits and distribution.

GeoProcessor Software

The OWF GeoProcessor software is a Python application and supporting modules that runs QGIS Python modules and other code to process spatial data. The OWF GeoProcessor is under development and is being tested internally at OWF, with the expectation that it will be released publicly as an open source project in the first half of 2018. Documentation and tests are being provided in public repositories to evaluate opportunities to use on projects. The OWF GeoProcessor is designed to provide the following functionality:

1. Command-based workflow language similar to TSTool Software, but focusing on processing spatial data layers.
2. General commands similar to TSTool, such as file manipulation, logic controls such as For and If commands, and support for processor properties to allow dynamic scripting.
3. Spatial data processing commands for basic operations such as clipping, joining, format conversion, and coordinate system conversion.
   1. Leverage QGIS functionality.
   2. Commands beyond what QGIS provides.
4. Built-in test framework, which is used to run functional tests, suitable for software developers and also non-programmers who want to validate processing workflows.
5. Multiple run modes including batch, command shell interpreter, user interface, HTTP server.
6. Integration with other tools to leverage the strengths of those tools.

The goal is to allow software users to install QGIS, install the OWF GeoProcessor software, and begin automating simple to complex geoprocessing tasks. The approach also facilitates maintaining geoprocessing workflow in text files that can be maintained under version control, such as on GitHub.

Repository Contents

This repository contains the following main folders.

owf-app-geoprocessor-python-doc-dev/   GeoProcessor development repository.
  build-util/                          Scripts to view, build, and deploy documentation.
  mkdocs.yml                           MkDocs configuration file for website.
  docs/                                Markdown and other files for website.
  site/                                Created by MkDocs containing the static website - ignored using .gitignore.

Development Environment

The development environment for developer documentation requires installation of Python 3, MkDocs, and Material MkDocs theme. See the OWF / Learn MkDocs documentation for information about installing these tools.

The development environment will change as the developers upgrade to newer versions of software tools.

Editing and Viewing Content

If the development environment is properly configured, edit and view content as follows:

1. Edit content in the docs folder and update mkdocs.yml as appropriate.
2. Run the build-util/run-mkdocs-serve-8001.sh script (Linux) or equivalent.
3. View content in a web browser using URL http://localhost:8001.

Style Guide

The following are general style guide recommendations for this documentation, with the goal of keeping formatting simple in favor of focusing on useful content:

• Use the Material MkDocs theme - it looks nice, provides good navigation features, and enables search.
• Follow MkDocs Markdown standards - use extensions beyond basic Markdown when useful.
• Show files and program names as code (tick-surrounded) formatting.
• Where a source file can be linked to in GitHub, provide a link so that the most current file can be viewed.
• Use triple-tick formatting for code blocks, with language specifier.
• Use bold italics when referencing UI components such as menus.
• Use slashes to indicate Menu / SubMenu.
• Place images in a folder with the same name as the content file and include -images at the end of the folder name.
• Minimize the use of inlined HTML, but use it where Markdown formatting is limited.
• Although the Material them provides site and page navigation sidebars, provide in-line table of contents on pages, where appropriate, to facilitate review of page content.

License

This documentation is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Contributing

Contribute to the documentation as follows:

1. Use GitHub repository issues to report minor issues.
2. Use GitHub pull requests.

Maintainers

This repository is maintained by the Open Water Foundation.