EPANET Matlab Toolkit v2.2.6.1

Release Notes for EPANET Matlab Toolkit (EMT) v2.2.6.1

• Add the example Fasted Parallel computation
• Update the function getComputedTimeSeries_ENepanet to work in parallel
• Add the function readEpanetBinaryFile
• Add the function getNodeJunctionBaseDemands #230
• Add the function getNodeJunctionActualDemand #230

EPANET Matlab Toolkit v2.2.6

Merge pull request #231 from OpenWaterAnalytics/dev

Dev

EPANET Matlab Toolkit v2.2.5

Release Notes for EPANET Matlab Toolkit (EMT) v2.2.5

• Add the function getComputedAnalysisTimeSeries (Computed Hydraulic and Quality analysis)
• Update Movie example (use epanet class function instead of properties)
• Load epanet file with specific DLL without fill properties:
  d = epanet(inpname, 'epanet2', 'loadfile');
• Update the functions getAdjacencyMatrix, getFlowDirections
  help d.getAdjacencyMatrix
  help d.getFlowDirections
• Add the function getMSXComputedLinkQualitySpecie (Returns the link quality for specific specie)
• Add the function getMSXComputedNodeQualitySpecie (Returns the node quality for specific specie)
• Update in the function setMSXTimeStep
• Update the function loadMSXFile, e.g.

  d.loadMSXFile('net2-cl2.msx', 'epanetmsx');
  d.loadMSXFile('net2-cl2.msx', 'epanetmsx', 'loadfile');
  d.loadMSXFile('net2-cl2.msx', 'loadfile');
  

EPANET Matlab Toolkit v2.2.4

Release Notes for EPANET Matlab Toolkit (EMT) v2.2.4

• Update the LICENSE file to the last version of EUPL v. 1.2
• Minor fix in the function setNodeBaseDemands for the demand category (Thanks Roya @RPM-2022).
• Add the function getMSXComputedTimeSeries.
• Minor fix in the functions plotMSXSpeciesLinkConcentration, plotMSXSpeciesNodeConcentration
• Show a message when you set the wrong species index in the functions (getMSXComputed..)
• Add the library epanetmsx_thunk64 and msxepanet.m to help deploy an app with epanet msx.
• Add loadMSXEPANETFile and loadMSXlibrary functions. Used for parallel simulations.
• Minor fix in the function getLinkVolumes

EPANET Matlab Toolkit v2.2.3

Release Notes for EPANET Matlab Toolkit (EMT) v2.2.3

• Create CITATION.cff
• Create networkviewer.mlapp
• Minor fix in the function getAdjacencyMatrix
• Add the function getLinkVolumes
• Update the function getNodeLinks to return all the links to which all nodes are connected to
• Add the function plotDiGraph
• Add the function getFlowDirections
• Fix issue #222, a bug in highlightnode and legendposition
• Some updates in the movie example
• Fix issue #223, Error Recognizing setControl Function
• Merge release notes in one file

EPANET Matlab Toolkit v2.2.2

Release Notes for EPANET Matlab Toolkit (EMT) v2.2.2

• Performance updates (getComputed..)
• Update EX24_Parallel_computations.m
• Cleanup and some fixes
• When running d = epanet('Net1.inp') creates a temporary input file using the Matlab function copyfile instead of ENsaveinpfile the first time.
• Update Movie Examples
• We have prepared a tutorial as part of the CCWI-WDSA 2022 conference. You can find the files in the tutorial folder at the following GitHub repository.
  • Basic functionality
  • Run first EPANET analysis
  • Run first MSX analysis
  • How to include uncertainties in simulations
  • How to analyze network graph
  • How to place pressure sensors
  • How to create leakage events
  • How to detect leakage events
  • How to place quality sensors
  • How to create contamination events (using MSX)
  • How to detect contamination events

EPANET Matlab Toolkit v2.2.1

• ReleaseNotes2_2_1.md

• Examples

Check EPANET Matlab Toolkit v2.2.2

New Contributors

• @MariosDem

EPANET Matlab Toolkit v2.2.0

• Update DLLs - EPANET 2.2
• Fix bugs, cleanup, and updates
• Added help text in functions
• Added more examples: https://github.com/OpenWaterAnalytics/EPANET-Matlab-Toolkit/tree/master/examples#readme
• Add constant properties for pump state and bin status
• Accept index in setLinkTypePipe, setLinkTypePump etc
• Fix bug base demand error / auto-add new base demand categories
• List of EPANET 2.2 Functions Supported
• Added functions, see below

Added Functions

Function	Description
getComputedTimeSeries_ENepanet	Computed Hydraulic & Quality Time Series via ENepanet binary file
getCounts	Retrieves the number of network components
getCurveType	Retrieves the curve-type (VOLUME, PUMP, EFFICIENCY, HEADLOSS, GENERAL)
getCurveTypeIndex	Retrieves the curve-type index for all curves
getDemandModel	Retrieves the type of demand model in use and its parameters
getLinkActualQuality	Current computed link quality (read only)
getLinkComment	Retrieves the comment string assigned to the link object
getLinkNodesIndex-getNodesConnectingLinksIndex	Retrieves the indexes of the from/to nodes of all links
getLinkPumpEfficiency	Retrieves the value of all computed efficiency
getLinkPumpPower	Pump constant power rating
getLinkPumpHCurve	Pump head v. flow curve index
getLinkPumpECurve	Pump efficiency v. flow curve index
getLinkPumpECost	Pump average energy price
getLinkPumpEPat	Pump energy price time pattern index
getLinkPumpState	Current computed pump state (read only) (see @ref EN_PumpStateType)
getLinkResultIndex	Retrieves the order in which a link's results were saved to an output file. (EPANET Version 2.2)
getLinkVertices	Retrieves the coordinate's of a vertex point assigned to a link.
getLinkVerticesCount	Retrieves the number of internal vertex points assigned to a link
getNodeComment	Retrieves the comment string assigned to the node object
getNodeDemandDeficit	Retrieves the amount that full demand is reduced under PDA. (EPANET Version 2.2)
getNodeJunctionDemandName	Gets the name of a node's demand category
getNodeJunctionDemandIndex	Retrieves the demand index of the junctions. (EPANET Version 2.2)
getNodeResultIndex	Retrieves the order in which a node's results were saved to an output file. (EPANET Version 2.2)
getNodeTankData	Retrieves a group of properties for a tank. (EPANET Version 2.2)
getNodeTankCanOverFlow	Retrieves the tank can overflow (= 1) or not (= 0)
getNodeTankMixingFraction	Retrieves the tank Fraction of total volume occupied by the inlet/outlet zone in a 2-compartment tank
getOptionsDemandCharge	Retrieve energy price pattern
getOptionsSpecificGravity	Retrieves the specific gravity (EPANET Version 2.2)
getOptionsSpecificViscosity	Retrieves the specific viscosity (EPANET Version 2.2)
getOptionsExtraTrials	Retrieves the extra trials allowed if hydraulics don't converge (EPANET Version 2.2)
getOptionsCheckFrequency	Retrieves the frequency of hydraulic status checks (EPANET Version 2.2)
getOptionsMaximumCheck	Retrieves the maximum trials for status checking. (EPANET Version 2.2)
getOptionsFlowChange	Retrieve flow change
getOptionsGlobalEffic	Retrieve global efficiency pumps
getOptionsGlobalPrice	Retrieve global average energy price per kW-Hour
getOptionsGlobalPattern	Retrieve global pattern
getOptionsHeadError	Retrieve the head error
getOptionsHeadLossFormula	Retrieve headloss formula code (Hazen-Williams
getOptionsDampLimit	Retrieves the accuracy level where solution damping begins. (EPANET Version 2.2)
getOptionsSpecificDiffusivity	Retrieves the specific diffusivity (relative to chlorine at 20 deg C). (EPANET Version 2.2)
getOptionsPipeBulkReactionOrder	Retrieves the bulk water reaction order for pipes. (EPANET Version 2.2)
getOptionsPipeWallReactionOrder	Retrieves the wall reaction order for pipes (either 0 or 1). (EPANET Version 2.2)
getOptionsTankBulkReactionOrder	Retrieves the bulk water reaction order for tanks. (EPANET Version 2.2)
getOptionsLimitingConcentration	Retrieves the limiting concentration for growth reactions. (EPANET Version 2.2)
getPatternComment	Retrieves the comment string assigned to the pattern object
getRules	Retrieves the rule - based control statements. (EPANET Version 2.2)
getRuleCount	Retrieves the number of rules. (EPANET Version 2.2)
getRuleID	Retrieves the ID name of a rule-based control given its index. (EPANET Version 2.2)
getRuleInfo	Retrieves summary information about a rule-based control given it's index. (EPANET Version 2.2)
getTimeNextEventTank	Retrieves the index of tank with shortest time to become empty or full
getTitle	Retrieves the title lines of the project
addControls	Adds a new simple control. (EPANET Version 2.2)
addNodeJunctionDemand	Adds a new demand to a junction given the junction index
addRules	Adds a new rule-based control to a project. (EPANET Version 2.2)
deleteCurve	Deletes a data curve from the project
deletePattern	Deletes a time pattern from a project
deleteControls	Deletes an existing simple control. (EPANET Version 2.2)
deleteRules	Deletes an existing rule-based control given it's index. (EPANET Version 2.2)
clearReport	Clears the contents of a project's report file. (EPANET Version 2.2)
copyReport	Copies the current contents of a project's report file to another file. (EPANET Version 2.2)
runsCompleteSimulation	Runs a complete hydraulic and water simulation to create binary & report files with default name net_temp.bin or you can use argument to run via ENepanet
initializeEPANET	Initializes an EPANET project that isn't opened with an input file
openAnyInp	Open as on matlab editor any EPANET input file
openCurrentInp	Open EPANET input file who is loaded
setCurveNameID	Sets the name ID of a curve given it's index and the new ID. (EPANET Version 2.2)
setDemandModel	Sets the type of demand model to use and its parameters
setFlowUnitsAFD	Sets flow units to AFD
setFlowUnitsCFS	Sets flow units to CFS
setFlowUnitsCMD	Sets flow units to CMD
setFlowUnitsCMH	Sets flow units to CMH
setFlowUnitsGPM	Sets flow units to GPM
setFlowUnitsIMGD	Sets flow units to IMGD
setFlowUnitsLPM	Sets flow units to LPM
setFlowUnitsLPS	Sets flow units to LPS
setFlowUnitsMGD	Sets flow units to MGD
setFlowUnitsMLD	Sets flow units to MLD
setLinkComment	Sets the comment string assigned to the link object
setLinkPipeData	Sets a group of properties for a pipe. (EPANET Version 2.2)
setLinkPumpPatternIndex	Sets the pump speed time pattern index. (EPANET Version 2.2)
setLinkPumpPower	Sets the power for pumps. (EPANET Version 2.2)
setLinkPumpHCurve	Sets the pump head v. flow curve index. (EPANET Version 2.2)
setLinkPumpECurve	Sets the pump efficiency v. flow curve index. (EPANET Version 2.2)
setLinkPumpECost	Sets the pump average energy price. (EPANET Version 2.2)
setLinkPumpEPat	Sets the pump energy price time pattern index. (EPANET Version 2.2)
setLinkNameID	Sets the ID name for links
setLinkNodesIndex	Sets the indexes of a link's start- and end-nodes. (EPANET Version 2.2)
setLinkVertices	Assigns a set of internal vertex points to a link
setNodeComment	Sets the comment string assigned to the node object
setNodeJunctionDemandName	Assigns a name to a node's demand category
setNodeNameID	Sets the ID name for nodes
setNodesConnectingLinksID	Sets the ID of a link's start-node(s) and end-node(s). (EPANET Version 2.2)
setNodeTankData	Sets a group of properties for a tank. (EPANET Version 2.2)
setNodeTankCanOverFlow	Sets the value of tank can overflow (= 1) or not (= 0)
setNodeTankMixingFraction	Sets the values of tanks mix fraction
setOptionsGlobalEffic	Sets the value of global pump efficiency(percent) (EPANET Version 2.2)
setOptionsGlobalPrice	Sets the value of global energy price per KWH (EPANET Version 2.2)
setOptionsGlobalPattern	Sets the index of a global energy price pattern (EPANET Version 2.2)
setOptionsDemandCharge	Sets the energy demand charge per max. KW usage (EPANET Version 2.2)
setOptionsSpecificGravity	Sets the specific gravity (EPANET Version 2.2)
setOptionsSpecificViscosity	Sets the specific viscosity (EPANET Version 2.2)
setOptionsExtraTrials	Sets the extra trials allowed if hydraulics don't converge (EPANET Version 2.2)
setOptionsMaximumCheck	Sets the maximum trials for status checking. (EPANET Version 2.2)
setOptionsCheckFrequency	Sets the frequency of hydraulic status checks (EPANET Version 2.2)
setOptionsDampLimit	Sets the accuracy level where solution damping begins. (EPANET Version 2.2)
setOptionsSpecificDiffusivity	Sets the specific diffusivity (relative to chlorine at 20 deg C). (EPANET Version 2.2)
setOptionsPipeBulkReactionOrder	Sets the bulk water reaction order for pipes. (EPANET Version 2.2)
setOptionsPipeWallReactionOrder	Sets the wall reaction order for pipes (either 0 or 1). (EPANET Version 2.2)
setOptionsTankBulkReactionOrder	Sets the bulk water reaction order for tanks. (EPANET Version 2.2)
setOptionsLimitingConcentration	Sets the limiting concentration for growth reactions. (EPANET Version 2.2)
setPatternComment	Sets the comment string assigned to the pattern object
setPatternNameID	Sets the name ID of a time pattern given it's index and the new ID. (EPANET Version 2.2)
setRules	Sets a rule - based control. (EPANET Version 2.2)
setRuleElseAction	Sets rule - based control else actions. (EPANET Version 2.2)
setRulePremise	Sets the premise of a rule - based control. (EPANET Version 2.2)
setRulePremiseObejctNameID	Sets the ID of an object in a premise of a rule-based control. (EPANET Version 2.2)
setRulePremiseStatus	Sets the status being compared to in a premise of a rule-based control. (EPANET Version 2.2)
setRulePremiseValue	Sets the value being compared to in a premis...

EPANET Matlab Toolkit v2.2.0-gamma.3

fix bug base demand error / auto add new base demand categories if ne…

EPANET Matlab Toolkit v2.2.0-beta.9

add toolkit example 4 - network building