Package: epanet2toolkit 1.0.5

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]

epanet2toolkit_1.0.5.tar.gz
epanet2toolkit_1.0.5.zip(r-4.5)epanet2toolkit_1.0.5.zip(r-4.4)epanet2toolkit_1.0.5.zip(r-4.3)
epanet2toolkit_1.0.5.tgz(r-4.4-x86_64)epanet2toolkit_1.0.5.tgz(r-4.4-arm64)epanet2toolkit_1.0.5.tgz(r-4.3-x86_64)epanet2toolkit_1.0.5.tgz(r-4.3-arm64)
epanet2toolkit_1.0.5.tar.gz(r-4.5-noble)epanet2toolkit_1.0.5.tar.gz(r-4.4-noble)
epanet2toolkit_1.0.5.tgz(r-4.4-emscripten)epanet2toolkit_1.0.5.tgz(r-4.3-emscripten)
epanet2toolkit.pdf |epanet2toolkit.html✨
epanet2toolkit/json (API)

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

Peer review:

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

On CRAN:

epanetepanet-apisimulationwaterwater-distribution-networks

5.28 score 15 stars 64 scripts 336 downloads 106 exports 0 dependencies

Last updated 6 months agofrom:71b92ea467. Checks:OK: 9. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 04 2024
R-4.5-win-x86_64OKNov 04 2024
R-4.5-linux-x86_64OKNov 04 2024
R-4.4-win-x86_64OKNov 04 2024
R-4.4-mac-x86_64OKNov 04 2024
R-4.4-mac-aarch64OKNov 04 2024
R-4.3-win-x86_64OKNov 04 2024
R-4.3-mac-x86_64OKNov 04 2024
R-4.3-mac-aarch64OKNov 04 2024

Exports:ENaddcontrolENaddcurveENadddemandENaddlinkENaddnodeENaddpatternENclearreportENcloseENcloseHENcloseQENcopyreportENdeletecurveENdeletedemandENdeletelinkENdeletenodeENdeletepatternENepanetENgetaveragepatternvalueENgetbasedemandENgetcontrolENgetcoordENgetcountENgetcurveidENgetcurveindexENgetcurvelenENgetcurvetypeENgetcurvevalueENgetdemandindexENgetdemandmodelENgetdemandnameENgetdemandpatternENgetelseactionENgeterrorENgetflowunitsENgetheadcurveindexENgetlinkidENgetlinkindexENgetlinknodesENgetlinktypeENgetlinkvalueENgetnodeidENgetnodeindexENgetnodetypeENgetnodevalueENgetnumdemandsENgetoptionENgetpatternidENgetpatternindexENgetpatternlenENgetpatternvalueENgetpumptypeENgetqualinfoENgetqualtypeENgetstatisticENgetthenactionENgettimeparamENgetversionENgetvertexENgetvertexcountENinitHENinitQENnextHENnextQENopenENopenHENopenQENreportENresetreportENrunHENrunQENsaveHENsavehydfileENsaveinpfileENsetbasedemandENsetcontrolENsetcoordENsetcurveidENsetcurvevalueENsetdemandmodelENsetdemandnameENsetdemandpatternENsetelseactionENsetheadcurveindexENsetjuncdataENsetlinkidENsetlinknodesENsetlinktypeENsetlinkvalueENsetnodeidENsetnodevalueENsetoptionENsetpatternENsetpatternidENsetpatternvalueENsetqualtypeENsetreportENsetrulepriorityENsetstatusreportENsettankdataENsetthenactionENsettimeparamENsetverticesENsolveHENsolveQENstepQENusehydfile

Dependencies:

Readme and manuals

Help Manual

Help pageTopics
Add a new simple controlENaddcontrol
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 networkENaddlink
Adds a new nodeENaddnode
Add a new time patternENaddpattern
Adds a new rule-based control to a projectENaddrule
Clears the contents of a project's report file.ENclearreport
Close down the EPANET Toolkit system.ENclose
close hydraulics engineENcloseH
Close water quality analysis and free allocated memoryENcloseQ
Copies the current contents of a project's report file to another fileENcopyreport
Deletes an existing simple controlENdeletecontrol
Deletes a data curve from a projectENdeletecurve
Delete a demand from a junction nodeENdeletedemand
Delete a link from the project.ENdeletelink
Deletes a nodeENdeletenode
Delete a new time patternENdeletepattern
Deletes an existing rule-based controlENdeleterule
ENepanetENepanet
Get average of all time factors in a patternENgetaveragepatternvalue
Gets the base demand for one of a node's demand categories.ENgetbasedemand
ENgetcontrolENgetcontrol
Get coordinates for a nodeENgetcoord
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 typeENgetcurvetype
Retrieves the value of a single data point for a curve.ENgetcurvevalue
Retrieves the index of a node's named demand categoryENgetdemandindex
Get type of demand model in use and its parametersENgetdemandmodel
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 codeENgeterror
Retrieve a code number indicating the units used to express all flow rates.ENgetflowunits
Retrieves index of head curve used by a pumpENgetheadcurveindex
Retrieve the ID label of a linkENgetlinkid
Retrieve the index of a linkENgetlinkindex
Retrieve the index of the end nodes of a linkENgetlinknodes
Retrieve the type code for a linkENgetlinktype
Retrieve parameter value for a linkENgetlinkvalue
Retrieve the ID label a node.ENgetnodeid
Retrieve the index of a nodeENgetnodeindex
Retrieve the node-type codeENgetnodetype
Retrieve node parameter value.ENgetnodevalue
Get number of demands for a junction nodeENgetnumdemands
Retrieve the value of an analysis option.ENgetoption
Retrieve the ID label a time patternENgetpatternid
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 periodENgetpatternvalue
Gets the properties of a premise in a rule-based control.ENgetpremise
Retrieves type of head curve used by a pumpENgetpumptype
Get quality analysis informationENgetqualinfo
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 controlENgetthenaction
Get the value of one or more specific analysis time parameters.ENgettimeparam
ENgettitleENgettitle
Retrieve the current version number of the EPANET Toolkit.ENgetversion
Get vertex coordinatesENgetvertex
Get number of vertices for a linkENgetvertexcount
ENinitENinit
Initialize hydraulic engineENinitH
Initialize water quality analysisENinitQ
determine the next hydraulic stepENnextH
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 analysisENopenQ
Write simulation report to the report fileENreport
Resets a project's report options to their default values.ENresetreport
run hydraulics engineENrunH
Computs WQ results at current time .ENrunQ
ENsaveH Saves hydraulic results to binary fileENsaveH
Saves temporary hydraulics file to diskENsavehydfile
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 statementENsetcontrol
Set coordinates for a nodeENsetcoord
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 controlENsetelseaction
Sets flow units.ENsetflowunits
Sets index of head curve used by a pumpENsetheadcurveindex
Sets properties for a junctionENsetjuncdata
Change the ID of a linkENsetlinkid
Set the indexes of a link's start- and end-nodesENsetlinknodes
Change a link's typeENsetlinktype
Set a parameter value for a linkENsetlinkvalue
Changes the ID name of a nodeENsetnodeid
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 valueENsetpatternvalue
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 controlENsetpremiseindex
Sets the status being compared to in a premise of a rule-based controlENsetpremisestatus
Sets the value in a premise of a rule-based controlENsetpremisevalue
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 tankENsettankdata
Set properties of THEN action in a rule-based controlENsetthenaction
Set the value of a time parameter.ENsettimeparam
Set a link's verticesENsetvertices
ENsolveHENsolveH
Solve network water quality for all time periodsENsolveQ
Advances WQ simulation one water quality time step.ENstepQ
Uses previously saved binary hydraulics file to supply a project's hydraulics.ENusehydfile
epanet2toolkitepanet2toolkit-package epanet2toolkit