Implement SWMM-like variables and arithmetic in Epanet

epanet_port/AUTHORS

@@ -0,0 +1,60 @@
+# Authors ordered alphabetically.
+
+Authors with Contributions in the Public Domain:
+Lewis Rossman <LRossman@cinci.rr.com>
+Michael Tryby <tryby.michael@epa.gov>
+
+Version 2.0
+Lewis Rossman <LRossman@cinci.rr.com>
+
+Authors with Contributions Subject to Copyright (see LICENSE):
+Except where noted.
+
+Version 2.1
+Jinduan	Chen <jinduan.uc@gmail.com>
+Maurizio Cingi <mrzcng2@gmail.com>
+Demetrios Eliades <eldemet@gmail.com>
+Will Furnass <will@thearete.co.uk>
+Milad Ghiami <milad.ghiami67@gmail.com>
+Sam Hatchett <samhatchett@gmail.com>
+Mike Kane <muke195@gmail.com>
+Marios Kyriakou <mariosmsk@gmail.com>
+Steffen	Macke <sdteffen@sdteffen.de>
+Angela Marchi <angela.marchi@adelaide.edu.au>
+Bryant McDonnell <bemcdonnell@gmail.com>
+Lew Rossman <LRossman@cinci.rr.com>
+Elad Salomons <selad@optiwater.com>
+Feng Shang <fengshang72@gmail.com>	
+Yunier Soad <yunier.soad@gmail.com>
+Tom Taxon <tntaxon@anl.gov>
+Michael	Tryby <tryby.michael@epa.gov> (Contributions in the Public Domain)
+James Uber <jim@citilogics.com>
+Hyoungmin Woo <hyoungmin.woo@gmail.com>
+
+Version 2.2
+Demetrios Eliades <eldemet@gmail.com>
+Sam Hatchett <samhatchett@gmail.com>
+Abel Heinsbroek <mail@abelheinsbroek.nl>
+Marios Kyriakou <mariosmsk@gmail.com>
+Lewis Rossman <LRossman@cinci.rr.com>
+Elad Salomons <selad@optiwater.com>
+Markus Sunela <markus.sunela@fluidit.fi>
+Michael Tryby <tryby.michael@epa.gov> (Contributions in the Public Domain)
+
+Version 2.3
+Luke Butler <lukepbutler@gmail.com>
+Demetrios Eliades <eldemet@gmail.com>
+Sam Hatchett <samhatchett@gmail.com>
+Abel Heinsbroek <mail@abelheinsbroek.nl>
+Robert Janke <janke.robert@epa.gov>
+Marios Kyriakou <mariosmsk@gmail.com>
+Corey McNeish  
+0tkl <tkl.zhaoqing@gmail.com>
+Lewis Rossman <LRossman@cinci.rr.com>
+Elad Salomons <selad@optiwater.com>
+Alex Sinske 
+Sahand Tashak 
+Yu Chun Tsao 
+James Uber <jim@citilogics.com>
+Oscar Vegas Niño <ovegas141279@gmail.com>
+Dennis Zanutto <dennis.zanutto@kwrwater.nl>

epanet_port/BUILDING.md

@@ -0,0 +1,51 @@
+# Building
+
+The most straightforward way to build the EPANET files is by using `CMake` ([https://cmake.org/](https://cmake.org/)). `CMake` is a cross-platform build tool that generates platform native build systems that can be used with your compiler of choice. It uses a generator concept to represent different build tooling. `CMake` automatically detects the platform it is running on and generates the appropriate makefiles for the platform default compiler. Different generators can also be specified.
+
+The project's `CMake` file (`CMakeLists.txt`) is located in its root directory and supports builds for Linux, Mac OS and Windows. To build the EPANET library and its command line executable using `CMake`, first open a console window and navigate to the project's root directory. Then enter the following commands:
+
+```
+mkdir build
+cd build
+cmake ..
+cmake --build . --config Release
+```
+
+Note: under Windows, the third command should be `cmake .. -A Win32` for a 32-bit build or `cmake .. -A x64` for a 64-bit build when Microsoft Visual Studio is the default compiler.
+
+For Windows the resulting EPANET toolkit library `epanet2.dll` and its command line executable `runepanet.exe` are placed in the `build\bin\Release` directory. The `build\lib\Release` directory will contain an `epanet2.lib` file which is needed to build C/C++ applications using the Windows version of the library. For Linux and Mac OS the EPANET toolkit shared library `libepanet2.so` appears in the `build/lib` directory and the command line executable `runepanet` is in the `build/bin` directory.
+
+In addition, two Windows one-click-build scripts are included in the `win_build` directory:
+
+1. `Makefile2.bat`: this script uses the `CMake` file and requires the build tools for Visual Studio available from [https://visualstudio.microsoft.com/downloads/](https://visualstudio.microsoft.com/downloads/). The Community version will work just fine. This script was tested with Visual Studio 2017 and 2019.
+2. `Makefile.bat`: this is the legacy build script compatible with Visual Studio 2010 which conforms with the C89 Standard which was the standard EPANET supported from earlier versions. This script requires the installation of Microsoft Windows SDK 7.1 ([https://www.microsoft.com/en-us/download/details.aspx?id=8279](https://www.microsoft.com/en-us/download/details.aspx?id=8279)) and will probably not run correctly on later versions of the SDK. `CMake` is not used in this script.
+
+These two scripts build EPANET binaries for both the 32 and 64 bit Windows platforms, placing them in the `win_build\32bit` and `win_build\64bit` directories, respectively.
+
+A tutorial on [building OWA EPANET from source on Windows](tools/BuildAndTest.md), including running unit tests and performing regression testing, is also avaiable.
+
+## Alternative build with Conan
+Conan is an increasingly popular C/C++ package management suite. To build EPANET using Conan, use the following commands as a starting point:
+
+```
+conan build . -s build_type=Release
+conan export-pkg . -s build_type=Release
+```
+
+
+# Testing
+
+Unit tests have been written using the Boost Unit Testing Framework and other Boost libraries. The tests are compiled into individual executables that automatically perform checks on the EPANET toolkit and output libraries.
+
+The CMake build system has been configured with a build option for building tests. When enabled (`-DBUILD_TESTS=ON`) the test executables are built and registered with the CTest test runner, the default value for the test build option is off. The location of Boost can also be defined with `-DBOOST_ROOT="%BOOST_ROOT%"` if required.
+
+To build the test executables for the EPANET library, first open a console window and navigate to the project's root directory. Then enter the following commands:
+
+```
+mkdir build
+cd build
+cmake -DBUILD_TESTS=ON ..
+cmake --build . --config Release
+cd tests
+ctest -C Release --output-on-failure
+```

epanet_port/CMakeLists.txt

@@ -0,0 +1,103 @@
+# CMakeLists.txt - CMake configuration file for EPANET 2.3
+#
+# CMake is a cross-platform build tool. CMake generates platform native
+# build systems that can be used with your compiler of choice. CMake uses a
+# generator concept to represent different build tooling. CMake automatically
+# detects the platform it is running on and generates the appropriate makefiles
+# for the platform default compiler. Different generators can also be specified.
+#
+# Note: CMake requires that your platform build system and compiler are
+# properly installed. Build using Visual Studio requires msbuild shell.
+#
+# Build Options:
+#   BUILD_TESTS = ON/OFF
+#   BUILD_PY_LIB = ON/OFF
+#
+# Generic Invocation:
+#   cmake -E make_directory buildprod
+#   cd build
+#   cmake -G GENERATOR -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON ..
+#   cmake --build . --target SOME_TARGET --config Release
+#
+# More information:
+#   cmake --help
+#
+#   CMake is available at https://cmake.org/download/
+#
+
+cmake_minimum_required (VERSION 3.8.0)
+
+project(EPANET)
+
+# Append local dir to module search path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
+option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
+option(BUILD_TESTS "Build tests (requires Boost)" OFF)
+#option(BUILD_PY_LIB "Build library for Python wrapper" OFF)
+option(BUILD_COVERAGE "Build library for coverage" OFF)
+
+#IF (NOT BUILD_PY_LIB)
+  add_subdirectory(run)
+#ENDIF (NOT BUILD_PY_LIB)
+add_subdirectory(src/outfile)
+
+IF (BUILD_TESTS)
+    #Prep ourselves for compiling with boost
+    IF(WIN32)
+        set(Boost_USE_STATIC_LIBS       ON)
+    ELSE(TRUE)
+        set(Boost_USE_STATIC_LIBS       OFF)
+        add_definitions(-DBOOST_ALL_DYN_LINK)
+    ENDIF(WIN32)
+
+    find_package(Boost COMPONENTS unit_test_framework system thread filesystem)
+    include_directories (${Boost_INCLUDE_DIRS})
+
+    enable_testing()
+    add_subdirectory(tests)
+    add_subdirectory(tests/outfile)
+    add_subdirectory(tests/util)
+ENDIF (BUILD_TESTS)
+
+# Sets the output directory for executables and libraries.
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+
+# Sets the position independent code property for all targets
+SET(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+IF (APPLE)
+  set(INSTALL_NAME_DIR @executable_path/../lib)
+  set(CMAKE_MACOSX_RPATH 1)
+ENDIF (APPLE)
+
+IF (MSVC)
+  set(CMAKE_C_FLAGS_RELEASE "/GL")
+  add_definitions(-D_CRT_SECURE_NO_DEPRECATE -MT)
+ENDIF (MSVC)
+
+# configure file groups
+file(GLOB EPANET_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} src/*.c src/util/*.c)
+file(GLOB EPANET_LIB_ALL RELATIVE ${PROJECT_SOURCE_DIR} src/* src/util/*)
+source_group("Library" FILES ${EPANET_LIB_ALL})
+
+# the shared library
+IF(MSVC AND "${CMAKE_VS_PLATFORM_NAME}" MATCHES "(Win32)")
+  message("   ************************************")
+  message("   Configuring with epanet2.def mapping")
+  message("   ************************************")
+  add_library(epanet2 SHARED ${EPANET_LIB_ALL} ${PROJECT_SOURCE_DIR}/include/epanet2.def)
+  set_source_files_properties(${PROJECT_SOURCE_DIR}/include/epanet2.def PROPERTIES_HEADER_FILE_ONLY TRUE)
+ELSE(TRUE)
+  add_library(epanet2 ${EPANET_LIB_ALL})
+ENDIF(MSVC AND "${CMAKE_VS_PLATFORM_NAME}" MATCHES "(Win32)")
+
+target_include_directories(epanet2 PUBLIC ${PROJECT_SOURCE_DIR}/include)
+
+install(TARGETS epanet2 DESTINATION .)
+install(TARGETS runepanet DESTINATION .)
+install(FILES ./include/epanet2.h DESTINATION .)
+install(FILES ./include/epanet2_2.h DESTINATION .)
+install(FILES ./include/epanet2_enums.h DESTINATION .)

epanet_port/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting any member of the [project team](https://github.com/OpenWaterAnalytics/EPANET/wiki/Project-Team). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

epanet_port/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 (See AUTHORS)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice, list of authors, and this permission notice shall 
+be included in all copies or substantial portions of the Software. 
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

epanet_port/README.md

@@ -0,0 +1,34 @@
+OWA-EPANET
+======
+
+## Build Status
+[![Build status](https://ci.appveyor.com/api/projects/status/19wpg4g2cmj3oihl?svg=true)](https://ci.appveyor.com/project/OpenWaterAnalytics/epanet)
+[![linux](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/ccpp.yml/badge.svg)](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/ccpp.yml)
+[![macos](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/macos.yml/badge.svg)](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/macos.yml)
+[![epanet2-win32](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/win32.yml/badge.svg)](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/win32.yml)
+[![epanet2-win64](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/win64.yml/badge.svg)](https://github.com/OpenWaterAnalytics/EPANET/actions/workflows/win64.yml)
+
+## DESCRIPTION
+
+**EPANET** is an industry-standard program for modeling the hydraulic and water quality behavior of water distribution system pipe networks. The EPANET Programmer's Toolkit is a library of functions (or API) written in C that allow programmers to customize the use of EPANET's solution engine for their own applications. Both EPANET and its toolkit were originally developed by the U.S. Environmental Protection Agency (USEPA). If you are interested in using/extending the EPANET engine and its API for academic, personal, or commercial use, then you've come to the right place. [Read more about EPANET on Wikipedia](https://en.wikipedia.org/wiki/EPANET). (Please note that this project covers only the EPANET hydraulic and water quality solver engine, not the graphical user interface.)
+
+## INSTALLATION
+
+Instructions for building the OWA-EPANET Toolkit's function library as well as its command line executable from the source files in this repository can be found [here](https://github.com/OpenWaterAnalytics/EPANET/blob/master/BUILDING.md).
+
+## USAGE
+
+See the [full documentation](http://wateranalytics.org/EPANET/) of the OWA-EPANET API, along with examples of how to use the toolkit for water distribution system analysis. Additional information may be found on this project's [Wiki](https://github.com/OpenWaterAnalytics/EPANET/wiki).
+
+## CONTRIBUTING
+
+Everyone is welcome to participate in this project. Whether you are helping others to resolve issues, reporting a new issue that hasn't yet been discovered, suggesting a new feature that would benefit your workflow, or writing code (or tests, or scripts, or ...), we value your time and effort. The path for contribution starts with the [Issues](https://github.com/OpenWaterAnalytics/EPANET/issues). Look around at open Issues and the conversation around them, get engaged by commenting on an outstanding Issue or creating a new one. If you want to contribute code, it helps to give the community time to discuss the ideas you present and offer constructive feedback. Once you get a clear path forward, Fork this repo to your own account. Make your commits on your dev branch (or one based on dev). Once you are finished, you can open a Pull Request to test the code and discuss merging your changes back into the community repository. A [step-by-step tutorial](http://www.slideshare.net/demetriseliades/contributing-to-epanet-using-github-in-windows) on how to contribute to OWA-EPANET using GitHub is also available.
+
+## CREDITS
+
+The **Open Water Analytics** (OWA) Community is an international group of EPANET developers and users, whose objective is to provide group interaction and coordinated development of the EPANET codebase, to ensure that important new user interface and algorithmic features are identified and that these features progress efficiently from prototype code to production implementations. OWA is actively maintaining OWA-EPANET, a community-supported branch of USEPA EPANET, since May 2014. The full list of individuals contributing to this project can be found [here](https://github.com/OpenWaterAnalytics/EPANET/blob/dev/AUTHORS).
+
+## DISCLAIMER
+Although OWA is not formally affiliated with nor endorsed by USEPA, this project has been a collaborative effort between the two that builds upon and extends the USEPA’s legacy EPANET 2.0 code base. For the last "official" release of EPANET please go to the [USEPA website](https://www.epa.gov/water-research/epanet).
+
+For more general community discussion of the project, please go to [OWA Discussions](https://github.com/orgs/OpenWaterAnalytics/discussions).