WaterTAP User Interface API

This is the Python API that will be called by the UI backend to process changes from the UI front-end.

Introduction

This page describes an application programming interface (API) that is designed to help communicate information about a flowsheet and its variables to a user interface layer (or possibly several different kinds of user interface layers at the same time). The API also provides the ability, intended for the UI developer, to update the variable values and run “actions” such as building and solving the flowsheet.

For how-to guides on specific tasks, see the How-to guide for the UI API.

The entire external-facing API is in FlowsheetInterface.