WaterModels.jl

A Julia/JuMP Package for Water Distribution Network Optimization

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

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    5 of 16 committers (31.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

julia network optimization water

Keywords from Contributors

global-optimization mixed-integer-programming optimization-algorithms optimal-power-flow power-network gas-flow gas-network-formulations mixed-model nonlinear-programming hsl
Last synced: 6 months ago · JSON representation

Repository

A Julia/JuMP Package for Water Distribution Network Optimization

Basic Info
Statistics
  • Stars: 73
  • Watchers: 12
  • Forks: 12
  • Open Issues: 13
  • Releases: 13
Topics
julia network optimization water
Created almost 9 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License

README.md

WaterModels.jl

WaterModels Logo

Latest Documentation Status Development Build Status Code Coverage Status

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: - Clayton Barrows, National Renewable Energy Laboratory - Russell Bent, Los Alamos National Laboratory - Carleton Coffrin, Los Alamos National Laboratory - Donatella Pasqualini, Los Alamos National Laboratory - Devon Sigler, National Renewable Energy Laboratory - Jonathan Stickel, National Renewable Energy Laboratory

License

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

Owner

  • Name: advanced network science initiative
  • Login: lanl-ansi
  • Kind: organization
  • Email: ansi-info@lanl.gov
  • Location: Los Alamos, NM

Los Alamos Advanced Network Science Initiative

GitHub Events

Total
  • Issues event: 3
  • Watch event: 5
  • Delete event: 3
  • Issue comment event: 3
  • Push event: 7
  • Pull request event: 10
  • Fork event: 2
  • Create event: 4
Last Year
  • Issues event: 3
  • Watch event: 5
  • Delete event: 3
  • Issue comment event: 3
  • Push event: 7
  • Pull request event: 10
  • Fork event: 2
  • Create event: 4

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 812
  • Total Committers: 16
  • Avg Commits per committer: 50.75
  • Development Distribution Score (DDS): 0.276
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Byron Tasseff b****f@l****v 588
Byron Tasseff b****n@t****m 124
ccoffrin c****n@c****m 45
Byron Tasseff t****f@u****m 10
Oscar Dowson o****w@u****m 8
carleton c****c@l****v 7
Barrows c****s@n****v 6
HSKK-PC\HSKK h****h@g****m 4
Devon SIgler D****3@g****m 3
Jonathan Stickel j****l@g****m 3
Sai Krishna Kanth Hari - 318686 h****h@d****v 3
Sai Krishna Kanth Hari - 318686 h****h@d****v 3
odow o****n@g****m 3
Russell Bent r****t@l****v 2
github-actions[bot] 4****]@u****m 2
Julia TagBot 5****t@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 92
  • Total pull requests: 83
  • Average time to close issues: 5 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 8
  • Total pull request authors: 10
  • Average comments per issue: 1.83
  • Average comments per pull request: 1.16
  • Merged pull requests: 55
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 2
  • Pull requests: 8
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 15 days
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.88
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • tasseff (45)
  • ccoffrin (31)
  • rb004f (8)
  • jjstickel (3)
  • odow (2)
  • KristofferC (1)
  • claytonpbarrows (1)
  • JuliaTagBot (1)
Pull Request Authors
  • tasseff (24)
  • github-actions[bot] (16)
  • odow (13)
  • ccoffrin (12)
  • dsigler1234 (9)
  • jjstickel (3)
  • hskkanth (3)
  • claytonpbarrows (1)
  • jd-lara (1)
  • JuliaTagBot (1)
Top Labels
Issue Labels
enhancement (12)
Pull Request Labels
enhancement (1)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 26
proxy.golang.org: github.com/lanl-ansi/watermodels.jl
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/lanl-ansi/WaterModels.jl
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

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