A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

WaterModels.jl

Designed to enable computational evaluation of historical and emerging water network formulations and algorithms using a common platform.
https://github.com/lanl-ansi/WaterModels.jl

Category: Natural Resources
Sub Category: Water Supply and Quality

Keywords

julia network optimization water

Keywords from Contributors

energy-systems simulations optimizer power-systems mixed-integer-programming global-optimization transform markov-decision-processes distribution nonlinear-optimization

Last synced: about 19 hours ago
JSON representation

Repository metadata

A Julia/JuMP Package for Water Distribution Network Optimization

README.md

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 includes a quick start guide.
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 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" (20180033DR).
It is also supported by the Advanced Network Science Initiative at Los Alamos National Laboratory.

The primary developer is Byron Tasseff with support from the following contributors:

License

This code is provided under a modified BSD license as part of the Multi-Infrastructure Control and Optimization Toolkit (MICOT), C15024.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 812
Total Committers: 12
Avg Commits per committer: 67.667
Development Distribution Score (DDS): 0.111

Commits in past year: 3
Committers in past year: 1
Avg Commits per committer in past year: 3.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Byron Tasseff b****f@l****v 722
ccoffrin c****n@c****m 52
Oscar Dowson o****w 11
Barrows c****s@n****v 6
HSKK-PC\HSKK h****h@g****m 4
Devon SIgler D****3@g****m 3
Sai Krishna Kanth Hari - 318686 h****h@d****v 3
Sai Krishna Kanth Hari - 318686 h****h@d****v 3
Jonathan Stickel j****l@g****m 3
github-actions[bot] 4****] 2
Russell Bent r****t@l****v 2
Julia TagBot 5****t 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 93
Total pull requests: 77
Average time to close issues: 5 months
Average time to close pull requests: about 1 month
Total issue authors: 8
Total pull request authors: 10
Average comments per issue: 1.81
Average comments per pull request: 1.19
Merged pull request: 53
Bot issues: 0
Bot pull requests: 14

Past year issues: 4
Past year pull requests: 5
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 11 days
Past year issue authors: 2
Past year pull request authors: 1
Past year average comments per issue: 0.0
Past year average comments per pull request: 1.0
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/lanl-ansi/WaterModels.jl

Top Issue Authors

  • tasseff (45)
  • ccoffrin (31)
  • rb004f (8)
  • jjstickel (3)
  • KristofferC (2)
  • odow (2)
  • claytonpbarrows (1)
  • JuliaTagBot (1)

Top Pull Request Authors

  • tasseff (24)
  • github-actions[bot] (14)
  • ccoffrin (12)
  • dsigler1234 (9)
  • odow (9)
  • jjstickel (3)
  • hskkanth (3)
  • claytonpbarrows (1)
  • jd-lara (1)
  • JuliaTagBot (1)

Top Issue Labels

  • enhancement (12)

Top Pull Request Labels

  • enhancement (1)

Dependencies

.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-buildpkg latest composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest latest composite
  • julia-actions/setup-julia v1 composite
.github/workflows/documentation.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia latest composite
.github/workflows/CompatHelper.yml actions
.github/workflows/doc_cleanup.yml actions
  • actions/checkout v3 composite

Score: 6.939253946041507