Welcome to ProteusLib’s documentation!
Proteuslib is a National Alliance for Water Innovation (NAWI) funded initiative to create an open-source water treatment model library that is compatible with the IDAES Platform, an advanced process systems engineering tool developed by the U.S. Department of Energy. Refer here for more background information.
Documentation Organization
The documentation is organized into five major categories:
Getting Started - instructions for installation
Tutorials - interactive lessons
How To Guides - step by step instructions for tasks
Technical Reference - description of components and their API
Background - high level information and discussion
Collaborating Institutions
The ProteusLib development team is composed of researchers from:
National Energy Technology Laboratory
Lawrence Berkeley National Laboratory
National Renewable Energy Laboratory
Oak Ridge National Laboratory
Content
- Getting Started
- Tutorials
- How To Guides
- How to setup a simple RO model
- How to use configuration options in the RO model
- How to setup simple chemistry
- How to use apparent and true chemical species
- How to use inherent reactions
- How to scale a model
- How to scale chemical reactions
- How to scale chemical species
- How to explore a model with parameter sweep
- How to use the Electrolyte Database (EDB)
- How to contribute to ProteusLib’s development
- Technical Reference
- Background
- License Agreement
- Copyright