https://github.com/lanl-ansi/WaterModels.jl

A Julia/JuMP Package for Water Distribution Network Optimization
https://github.com/lanl-ansi/WaterModels.jl

julia network optimization water

Last synced: 3 months ago
JSON representation

A Julia/JuMP Package for Water Distribution Network Optimization

• Host: GitHub
• URL: https://github.com/lanl-ansi/WaterModels.jl
• Owner: lanl-ansi
• License: other
• Created: 2017-05-22T17:45:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T22:12:58.000Z (7 months ago)
• Last Synced: 2024-06-11T16:00:20.114Z (5 months ago)
• Topics: julia, network, optimization, water
• Language: Julia
• Homepage: https://lanl-ansi.github.io/WaterModels.jl/latest/
• Size: 2.88 MB
• Stars: 70
• Watchers: 12
• Forks: 11
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• open-sustainable-technology - WaterModels.jl - Designed to enable computational evaluation of historical and emerging water network formulations and algorithms using a common platform. (Natural Resources / Water Supply and Quality)

README

        
# WaterModels.jl



  

WaterModels.jl is a Julia/JuMP package for steady state water network optimization.

It is designed to enable computational evaluation of historical and emerging water network formulations and algorithms using a common platform.

The code is engineered to decouple problem specifications (e.g., network design, optimal water flow) from network optimization formulations (e.g., mixed-integer linear, mixed-integer nonlinear).

This decoupling enables the definition of a wide variety of optimization formulations and their comparison on common problem specifications.

**Core Problem Specifications**

* Water Flow (`wf` and `mn_wf`) - obtain feasible flows and heads for a network

* Optimal Water Flow (`owf` and `mn_owf`) - minimize the cost of network operation

* Network Design (`des`) - minimize the cost of network design

**Core Network Formulations**

* NC - nonconvex nonlinear formulation

* NCD - nonconvex nonlinear direction-based formulation

* CRD - continuous (convex) relaxation- and direction-based formulation

* LRD - linear relaxation- and direction-based formulation

* PWLRD - piecewise linear relaxation- and direction-based formulation

* LA - linear approximation-based formulation

## Documentation

The package [documentation](https://lanl-ansi.github.io/WaterModels.jl/latest) includes a [quick start guide](https://lanl-ansi.github.io/WaterModels.jl/latest/quickguide).

Be advised that aside from the quick start guide, documentation is under development and may currently be inaccurate.

## Development

Community-driven development and enhancement of WaterModels is welcomed and encouraged.

Please feel free to fork this repository and share your contributions to the master branch with a pull request.

That said, it is important to keep in mind the code quality requirements and scope of WaterModels before preparing a contribution.

See [CONTRIBUTING.md](https://github.com/lanl-ansi/WaterModels.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.

## Acknowledgments

This work is currently supported by the Advanced Grid Modeling Program within the U.S. Department of Energy under the project "Coordinated Planning and Operation of Water and Power Infrastructures for Increased Resilience and Reliability."

Work at Los Alamos National Laboratory is conducted under the auspices of the National Nuclear Security Administration of the U.S. Department of Energy under Contract No. 89233218CNA000001.

Previous work was supported by the Los Alamos National Laboratory Directed Research and Development program under the project ["Adaptation Science for Complex Natural-engineered Systems"](http://www.lanl.gov/projects/nesma) (20180033DR).

It is also supported by the [Advanced Network Science Initiative](https://lanl-ansi.github.io) at Los Alamos National Laboratory.

The primary developer is [Byron Tasseff](https://github.com/tasseff) with support from the following contributors:

- [Clayton Barrows](https://github.com/claytonpbarrows), National Renewable Energy Laboratory

- [Russell Bent](https://github.com/rb004f), Los Alamos National Laboratory

- [Carleton Coffrin](https://github.com/ccoffrin), Los Alamos National Laboratory

- Donatella Pasqualini, Los Alamos National Laboratory

- [Devon Sigler](https://github.com/dsigler1234), National Renewable Energy Laboratory

- [Jonathan Stickel](https://github.com/jjstickel), National Renewable Energy Laboratory

## License

This code is provided under a [modified BSD license](https://github.com/lanl-ansi/WaterModels.jl/blob/master/LICENSE.md) as part of the Multi-Infrastructure Control and Optimization Toolkit (MICOT), C15024.