Package: epanet2toolkit 1.0.8

epanet2toolkit: Call 'EPANET' Functions to Simulate Pipe Networks

Enables simulation of water piping networks using 'EPANET'. The package provides functions from the 'EPANET' programmer's toolkit as R functions so that basic or customized simulations can be carried out from R. The package uses 'EPANET' version 2.2 from Open Water Analytics <https://github.com/OpenWaterAnalytics/EPANET/releases/tag/v2.2>.

Authors:Ernesto Arandia [aut], Bradley Eck [aut, cre], Lew Rossman [aut], Michael Tryby [ctb], Sam Hatchett [ctb], Feng Shang [ctb], James Uber [ctb], Tom Taxon [ctb], Hyoungmin Woo [ctb], Jinduan Chen [ctb], Yunier Soad [ctb], Mike Kane [ctb], Demetrios Eliades [ctb], Will Furnass [ctb], Steffen Macke [ctb], Marios Kyriakou [ctb], Elad Salomons [ctb], Maurizio Cingi [ctb], Bryant McDonnell [ctb], Angela Marchi [ctb], Markus Sunela [ctb], Milad Ghiami [ctb], IBM Corp. [cph], Open Water Analytics [cph]

# Install 'epanet2toolkit' in R:

install.packages('epanet2toolkit', repos = c('https://bradleyjeck.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/bradleyjeck/epanet2toolkit/issues

On CRAN:

epanet epanet-api simulation water water-distribution-networks

4.71 score 16 stars 64 scripts 383 downloads 106 exports 0 dependencies

Last updated from:ac49782273. Checks:13 OK, 2 ERROR. Indexed: yes.

Target	Result	Time
linux-devel-arm64	OK	133
linux-devel-x86_64	OK	133
source / vignettes	OK	170
linux-release-arm64	OK	121
linux-release-x86_64	OK	145
macos-release-arm64	OK	174
macos-release-x86_64	OK	234
macos-oldrel-arm64	OK	208
macos-oldrel-x86_64	OK	275
windows-devel-arm64	ERROR	285
windows-devel-x86_64	OK	116
windows-release-arm64	ERROR	336
windows-release-x86_64	OK	105
windows-oldrel-x86_64	OK	89
wasm-release	OK	111

Exports:ENaddcontrol ENaddcurve ENadddemand ENaddlink ENaddnode ENaddpattern ENclearreport ENclose ENcloseH ENcloseQ ENcopyreport ENdeletecurve ENdeletedemand ENdeletelink ENdeletenode ENdeletepattern ENepanet ENgetaveragepatternvalue ENgetbasedemand ENgetcontrol ENgetcoord ENgetcount ENgetcurveid ENgetcurveindex ENgetcurvelen ENgetcurvetype ENgetcurvevalue ENgetdemandindex ENgetdemandmodel ENgetdemandname ENgetdemandpattern ENgetelseaction ENgeterror ENgetflowunits ENgetheadcurveindex ENgetlinkid ENgetlinkindex ENgetlinknodes ENgetlinktype ENgetlinkvalue ENgetnodeid ENgetnodeindex ENgetnodetype ENgetnodevalue ENgetnumdemands ENgetoption ENgetpatternid ENgetpatternindex ENgetpatternlen ENgetpatternvalue ENgetpumptype ENgetqualinfo ENgetqualtype ENgetstatistic ENgetthenaction ENgettimeparam ENgetversion ENgetvertex ENgetvertexcount ENinitH ENinitQ ENnextH ENnextQ ENopen ENopenH ENopenQ ENreport ENresetreport ENrunH ENrunQ ENsaveH ENsavehydfile ENsaveinpfile ENsetbasedemand ENsetcontrol ENsetcoord ENsetcurveid ENsetcurvevalue ENsetdemandmodel ENsetdemandname ENsetdemandpattern ENsetelseaction ENsetheadcurveindex ENsetjuncdata ENsetlinkid ENsetlinknodes ENsetlinktype ENsetlinkvalue ENsetnodeid ENsetnodevalue ENsetoption ENsetpattern ENsetpatternid ENsetpatternvalue ENsetqualtype ENsetreport ENsetrulepriority ENsetstatusreport ENsettankdata ENsetthenaction ENsettimeparam ENsetvertices ENsolveH ENsolveQ ENstepQ ENusehydfile

Dependencies:

Help page	Topics
Add a new simple control	ENaddcontrol
Adds a new data curve to a project.	ENaddcurve
Appends a new demand to a junction node demands list.	ENadddemand
Add a link to the network	ENaddlink
Adds a new node	ENaddnode
Add a new time pattern	ENaddpattern
Adds a new rule-based control to a project	ENaddrule
Clears the contents of a project's report file.	ENclearreport
Close down the EPANET Toolkit system.	ENclose
close hydraulics engine	ENcloseH
Close water quality analysis and free allocated memory	ENcloseQ
Copies the current contents of a project's report file to another file	ENcopyreport
Deletes an existing simple control	ENdeletecontrol
Deletes a data curve from a project	ENdeletecurve
Delete a demand from a junction node	ENdeletedemand
Delete a link from the project.	ENdeletelink
Deletes a node	ENdeletenode
Delete a new time pattern	ENdeletepattern
Deletes an existing rule-based control	ENdeleterule
ENepanet	ENepanet
Get average of all time factors in a pattern	ENgetaveragepatternvalue
Gets the base demand for one of a node's demand categories.	ENgetbasedemand
ENgetcontrol	ENgetcontrol
Get coordinates for a node	ENgetcoord
Get number of network elements.	ENgetcount
Retrieves the ID name of a curve given its index.	ENgetcurveid
Retrieves the index of a curve given its ID name.	ENgetcurveindex
Retrieves the number of points in a curve.	ENgetcurvelen
Retrieves a curve's type	ENgetcurvetype
Retrieves the value of a single data point for a curve.	ENgetcurvevalue
Retrieves the index of a node's named demand category	ENgetdemandindex
Get type of demand model in use and its parameters	ENgetdemandmodel
Retrieves the name of a node's demand category.	ENgetdemandname
Gets the base demand for one of a node's demand categories.	ENgetdemandpattern
Gets the properties of an ELSE action in a rule-based control.	ENgetelseaction
Returns the text of an error message generated by an error code	ENgeterror
Retrieve a code number indicating the units used to express all flow rates.	ENgetflowunits
Retrieves index of head curve used by a pump	ENgetheadcurveindex
Retrieve the ID label of a link	ENgetlinkid
Retrieve the index of a link	ENgetlinkindex
Retrieve the index of the end nodes of a link	ENgetlinknodes
Retrieve the type code for a link	ENgetlinktype
Retrieve parameter value for a link	ENgetlinkvalue
Retrieve the ID label a node.	ENgetnodeid
Retrieve the index of a node	ENgetnodeindex
Retrieve the node-type code	ENgetnodetype
Retrieve node parameter value.	ENgetnodevalue
Get number of demands for a junction node	ENgetnumdemands
Retrieve the value of an analysis option.	ENgetoption
Retrieve the ID label a time pattern	ENgetpatternid
Retrieve the index a time pattern.	ENgetpatternindex
Retrieve the number of time periods in a time pattern.	ENgetpatternlen
Retrieve the multiplier factor for a specific time period	ENgetpatternvalue
Gets the properties of a premise in a rule-based control.	ENgetpremise
Retrieves type of head curve used by a pump	ENgetpumptype
Get quality analysis information	ENgetqualinfo
Retrieve the type of water quality analysis called for.	ENgetqualtype
Retrieves the order in which a node or link appears in an output file.	ENgetresultindex
Retrieves summary information about a rule-based control.	ENgetrule
Gets the ID name of a rule-based control given its index.	ENgetruleID
Analysis convergence statistics.	ENgetstatistic
Gets properties of THEN action in rule-based control	ENgetthenaction
Get the value of one or more specific analysis time parameters.	ENgettimeparam
ENgettitle	ENgettitle
Retrieve the current version number of the EPANET Toolkit.	ENgetversion
Get vertex coordinates	ENgetvertex
Get number of vertices for a link	ENgetvertexcount
ENinit	ENinit
Initialize hydraulic engine	ENinitH
Initialize water quality analysis	ENinitQ
determine the next hydraulic step	ENnextH
Advances WQ simulation to start of the next hydraulic time period.	ENnextQ
Open the EPANET Toolkit.	ENopen
Open hydraulics analysis system.	ENopenH
Sets up for Water Quality analysis	ENopenQ
Write simulation report to the report file	ENreport
Resets a project's report options to their default values.	ENresetreport
run hydraulics engine	ENrunH
Computs WQ results at current time .	ENrunQ
ENsaveH Saves hydraulic results to binary file	ENsaveH
Saves temporary hydraulics file to disk	ENsavehydfile
ENaveinpfile Saves current data to "INP" formatted text file.	ENsaveinpfile
Sets the base demand for one of a node's demand categories.	ENsetbasedemand
Set the parameters of a simple control statement	ENsetcontrol
Set coordinates for a node	ENsetcoord
Changes the ID name of a data curve given its index.	ENsetcurveid
Sets the value of a single data point for a curve.	ENsetcurvevalue
Sets the type of demand model to use and its parameters.	ENsetdemandmodel
Sets the name of a node's demand category.	ENsetdemandname
Sets the index of a time pattern used for one of a node's demand categories.	ENsetdemandpattern
Set properties of an ELSE action in a rule-based control	ENsetelseaction
Sets flow units.	ENsetflowunits
Sets index of head curve used by a pump	ENsetheadcurveindex
Sets properties for a junction	ENsetjuncdata
Change the ID of a link	ENsetlinkid
Set the indexes of a link's start- and end-nodes	ENsetlinknodes
Change a link's type	ENsetlinktype
Set a parameter value for a link	ENsetlinkvalue
Changes the ID name of a node	ENsetnodeid
Set the parameter value for a node.	ENsetnodevalue
Set the value of a particular analysis option.	ENsetoption
Set all of the multiplier factors for a specific time pattern.	ENsetpattern
Change the ID name of a time pattern given its index.	ENsetpatternid
set pattern value	ENsetpatternvalue
Sets the properties of a premise in a rule-based control.	ENsetpremise
Sets the index of an object in a premise of a rule-based control	ENsetpremiseindex
Sets the status being compared to in a premise of a rule-based control	ENsetpremisestatus
Sets the value in a premise of a rule-based control	ENsetpremisevalue
Set the type of water quality analysis called for.	ENsetqualtype
Processes a reporting format command.	ENsetreport
Sets the priority of a rule-based control.	ENsetrulepriority
Sets the level of hydraulic status reporting.	ENsetstatusreport
Sets properties for a tank	ENsettankdata
Set properties of THEN action in a rule-based control	ENsetthenaction
Set the value of a time parameter.	ENsettimeparam
Set a link's vertices	ENsetvertices
ENsolveH	ENsolveH
Solve network water quality for all time periods	ENsolveQ
Advances WQ simulation one water quality time step.	ENstepQ
Uses previously saved binary hydraulics file to supply a project's hydraulics.	ENusehydfile

Package: epanet2toolkit 1.0.8

epanet2toolkit: Call 'EPANET' Functions to Simulate Pipe Networks

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)