Open Water Foundation / GeoProcessor (for Developers)

This documentation provides resources to learn how to develop the Open Water Foundation (OWF) GeoProcessor software, which automates processing spatial data.

This documentation is intended for GeoProcessor developers that have experience with Python, QGIS Python libraries, and Python development environment. The PyCharm Community Edition is used by the Open Water Foundation as the Integrated Development Environment (IDE), although other tools could be used. PyCharm project files are not included in the repository.

The primary development environment at the Open Water Foundation is currently Windows 10 using the latest stable QGIS 3.x release. The primary deployment environments are Windows 7/10, and Ubuntu/Debian Linux. A non-QGIS distribution is also available, in order to use the GeoProcessor workflow as a "function test" framework. Additional environments may be supported depending on funding and developer resources.

The GeoProcessor software is currently under development at the Open Water Foundation. Documentation and tests are being published to facilitate collaboration and evaluation by potential software users. The software will be published as an open source software project once a critical mass of initial functionality is in place, with appropriate tests and documentation.

About the Open Water Foundation

The Open Water Foundation is a nonprofit social enterprise that focuses on developing and supporting open source software for water resources, so that organizations can make better decisions about water. OWF also works to advance open data tools.

See also other OWF learning resources.

How to Use this Documentation

The documentation is organized in order of information that will be useful to new and continuing developers.

This documentation is not intended to be a full reference for Geographic Information Systems (GIS) concepts or GIS technologies. See the Resources section for additional information from other sources.

Use the navigation menu provided on the left side of the page to navigate the documentation sections within the full document. Use the navigation menu provided on the right side of the page to navigate the documentation sections with a page. The navigation menus may not be displayed if the web browser window is narrow or if viewing on a mobile device, in which case look for a menu icon to access the menus. Use the search feature to find documentation matching the search words.

See also the OWF GeoProcessor documentation for users, which provides documentation for installing and using the GeoProcessor.

License

The OWF GeoProcessor developer documentation is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Source Repository on GitHub

The source files for this documentation are maintained in the OWF GeoProcessor GitHub repository (owf-app-geoprocessor-python) in the doc-dev-mkdocs-project folder.

Release Notes

See the Release Notes in the GitHub Project README. The documentation is typically published on the OWF website after any changes have been made.