From 19dcb747d4980097f18266ff381fad7d177f5d29 Mon Sep 17 00:00:00 2001 From: "Marios S. Kyriakou" Date: Tue, 28 Nov 2023 17:44:43 +0200 Subject: [PATCH] another update in docs. --- docs/{epyt.rst => api.rst} | 0 docs/index.rst | 2 +- docs/source/api.rst | 596 ------------------------------------- 3 files changed, 1 insertion(+), 597 deletions(-) rename docs/{epyt.rst => api.rst} (100%) delete mode 100644 docs/source/api.rst diff --git a/docs/epyt.rst b/docs/api.rst similarity index 100% rename from docs/epyt.rst rename to docs/api.rst diff --git a/docs/index.rst b/docs/index.rst index 35755fb..eb1e321 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,7 +30,7 @@ Welcome to EPyT's documentation! overview installation usage - source/api + api examples changelog diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index 4b8e97a..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,596 +0,0 @@ -API documentation ------------------ - -.. currentmodule:: epanet - -.. autoclass:: epanet - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~epanet.__init__ - ~epanet.addControls - ~epanet.addCurve - ~epanet.addLinkPipe - ~epanet.addLinkPipeCV - ~epanet.addLinkPump - ~epanet.addLinkValveFCV - ~epanet.addLinkValveGPV - ~epanet.addLinkValvePBV - ~epanet.addLinkValvePRV - ~epanet.addLinkValvePSV - ~epanet.addLinkValveTCV - ~epanet.addNodeJunction - ~epanet.addNodeJunctionDemand - ~epanet.addNodeReservoir - ~epanet.addNodeTank - ~epanet.addPattern - ~epanet.addRules - ~epanet.appRotateNetwork - ~epanet.appShiftNetwork - ~epanet.arange - ~epanet.clearReport - ~epanet.closeHydraulicAnalysis - ~epanet.closeNetwork - ~epanet.closeQualityAnalysis - ~epanet.copyReport - ~epanet.createProject - ~epanet.deleteAllTemps - ~epanet.deleteControls - ~epanet.deleteCurve - ~epanet.deleteLink - ~epanet.deleteNode - ~epanet.deleteNodeJunctionDemand - ~epanet.deletePattern - ~epanet.deleteProject - ~epanet.deleteRules - ~epanet.getCMDCODE - ~epanet.getComputedHydraulicTimeSeries - ~epanet.getComputedQualityTimeSeries - ~epanet.getComputedTimeSeries - ~epanet.getComputedTimeSeries_ENepanet - ~epanet.getConnectivityMatrix - ~epanet.getControlRulesCount - ~epanet.getControls - ~epanet.getCounts - ~epanet.getCurveComment - ~epanet.getCurveCount - ~epanet.getCurveIndex - ~epanet.getCurveLengths - ~epanet.getCurveNameID - ~epanet.getCurveType - ~epanet.getCurveTypeIndex - ~epanet.getCurveValue - ~epanet.getCurvesInfo - ~epanet.getDemandModel - ~epanet.getENfunctionsImpemented - ~epanet.getError - ~epanet.getFlowUnits - ~epanet.getLibFunctions - ~epanet.getLinkActualQuality - ~epanet.getLinkBulkReactionCoeff - ~epanet.getLinkComment - ~epanet.getLinkCount - ~epanet.getLinkDiameter - ~epanet.getLinkEnergy - ~epanet.getLinkFlows - ~epanet.getLinkHeadloss - ~epanet.getLinkIndex - ~epanet.getLinkInitialSetting - ~epanet.getLinkInitialStatus - ~epanet.getLinkLength - ~epanet.getLinkMinorLossCoeff - ~epanet.getLinkNameID - ~epanet.getLinkNodesIndex - ~epanet.getLinkPipeCount - ~epanet.getLinkPipeIndex - ~epanet.getLinkPipeNameID - ~epanet.getLinkPumpCount - ~epanet.getLinkPumpECost - ~epanet.getLinkPumpECurve - ~epanet.getLinkPumpEPat - ~epanet.getLinkPumpEfficiency - ~epanet.getLinkPumpHCurve - ~epanet.getLinkPumpHeadCurveIndex - ~epanet.getLinkPumpIndex - ~epanet.getLinkPumpNameID - ~epanet.getLinkPumpPatternIndex - ~epanet.getLinkPumpPatternNameID - ~epanet.getLinkPumpPower - ~epanet.getLinkPumpState - ~epanet.getLinkPumpSwitches - ~epanet.getLinkPumpType - ~epanet.getLinkPumpTypeCode - ~epanet.getLinkQuality - ~epanet.getLinkResultIndex - ~epanet.getLinkRoughnessCoeff - ~epanet.getLinkSettings - ~epanet.getLinkStatus - ~epanet.getLinkType - ~epanet.getLinkTypeIndex - ~epanet.getLinkValveCount - ~epanet.getLinkValveIndex - ~epanet.getLinkValveNameID - ~epanet.getLinkVelocity - ~epanet.getLinkVertices - ~epanet.getLinkVerticesCount - ~epanet.getLinkWallReactionCoeff - ~epanet.getLinksInfo - ~epanet.getNodeActualDemand - ~epanet.getNodeActualDemandSensingNodes - ~epanet.getNodeActualQuality - ~epanet.getNodeActualQualitySensingNodes - ~epanet.getNodeBaseDemands - ~epanet.getNodeComment - ~epanet.getNodeCoordinates - ~epanet.getNodeCount - ~epanet.getNodeDemandCategoriesNumber - ~epanet.getNodeDemandDeficit - ~epanet.getNodeDemandPatternIndex - ~epanet.getNodeDemandPatternNameID - ~epanet.getNodeElevations - ~epanet.getNodeEmitterCoeff - ~epanet.getNodeHydraulicHead - ~epanet.getNodeIndex - ~epanet.getNodeInitialQuality - ~epanet.getNodeJunctionCount - ~epanet.getNodeJunctionDemandIndex - ~epanet.getNodeJunctionDemandName - ~epanet.getNodeJunctionIndex - ~epanet.getNodeJunctionNameID - ~epanet.getNodeMassFlowRate - ~epanet.getNodeNameID - ~epanet.getNodePatternIndex - ~epanet.getNodePressure - ~epanet.getNodeReservoirCount - ~epanet.getNodeReservoirIndex - ~epanet.getNodeReservoirNameID - ~epanet.getNodeResultIndex - ~epanet.getNodeSourcePatternIndex - ~epanet.getNodeSourceQuality - ~epanet.getNodeSourceType - ~epanet.getNodeSourceTypeIndex - ~epanet.getNodeTankBulkReactionCoeff - ~epanet.getNodeTankCanOverFlow - ~epanet.getNodeTankCount - ~epanet.getNodeTankData - ~epanet.getNodeTankDiameter - ~epanet.getNodeTankIndex - ~epanet.getNodeTankInitialLevel - ~epanet.getNodeTankInitialWaterVolume - ~epanet.getNodeTankMaximumWaterLevel - ~epanet.getNodeTankMaximumWaterVolume - ~epanet.getNodeTankMinimumWaterLevel - ~epanet.getNodeTankMinimumWaterVolume - ~epanet.getNodeTankMixZoneVolume - ~epanet.getNodeTankMixingFraction - ~epanet.getNodeTankMixingModelCode - ~epanet.getNodeTankMixingModelType - ~epanet.getNodeTankNameID - ~epanet.getNodeTankReservoirCount - ~epanet.getNodeTankVolume - ~epanet.getNodeTankVolumeCurveIndex - ~epanet.getNodeType - ~epanet.getNodeTypeIndex - ~epanet.getNodesConnectingLinksID - ~epanet.getNodesConnectingLinksIndex - ~epanet.getNodesInfo - ~epanet.getOptionsAccuracyValue - ~epanet.getOptionsCheckFrequency - ~epanet.getOptionsDampLimit - ~epanet.getOptionsDemandCharge - ~epanet.getOptionsEmitterExponent - ~epanet.getOptionsExtraTrials - ~epanet.getOptionsFlowChange - ~epanet.getOptionsGlobalEffic - ~epanet.getOptionsGlobalPattern - ~epanet.getOptionsGlobalPrice - ~epanet.getOptionsHeadError - ~epanet.getOptionsHeadLossFormula - ~epanet.getOptionsLimitingConcentration - ~epanet.getOptionsMaxTrials - ~epanet.getOptionsMaximumCheck - ~epanet.getOptionsPatternDemandMultiplier - ~epanet.getOptionsPipeBulkReactionOrder - ~epanet.getOptionsPipeWallReactionOrder - ~epanet.getOptionsQualityTolerance - ~epanet.getOptionsSpecificDiffusivity - ~epanet.getOptionsSpecificGravity - ~epanet.getOptionsSpecificViscosity - ~epanet.getOptionsTankBulkReactionOrder - ~epanet.getPattern - ~epanet.getPatternAverageValue - ~epanet.getPatternComment - ~epanet.getPatternCount - ~epanet.getPatternIndex - ~epanet.getPatternLengths - ~epanet.getPatternNameID - ~epanet.getPatternValue - ~epanet.getQualityCode - ~epanet.getQualityInfo - ~epanet.getQualityTraceNodeIndex - ~epanet.getQualityType - ~epanet.getRuleCount - ~epanet.getRuleID - ~epanet.getRuleInfo - ~epanet.getRules - ~epanet.getStatistic - ~epanet.getTimeHTime - ~epanet.getTimeHaltFlag - ~epanet.getTimeHydraulicStep - ~epanet.getTimeNextEvent - ~epanet.getTimeNextEventTank - ~epanet.getTimePatternStart - ~epanet.getTimePatternStep - ~epanet.getTimeQTime - ~epanet.getTimeQualityStep - ~epanet.getTimeReportingPeriods - ~epanet.getTimeReportingStart - ~epanet.getTimeReportingStep - ~epanet.getTimeRuleControlStep - ~epanet.getTimeSimulationDuration - ~epanet.getTimeStartTime - ~epanet.getTimeStatisticsIndex - ~epanet.getTimeStatisticsType - ~epanet.getTitle - ~epanet.getUnits - ~epanet.getVersion - ~epanet.initializeEPANET - ~epanet.initializeHydraulicAnalysis - ~epanet.initializeQualityAnalysis - ~epanet.loadEPANETFile - ~epanet.max - ~epanet.min - ~epanet.multiply_elements - ~epanet.nextHydraulicAnalysisStep - ~epanet.nextQualityAnalysisStep - ~epanet.openAnyInp - ~epanet.openCurrentInp - ~epanet.openHydraulicAnalysis - ~epanet.openQualityAnalysis - ~epanet.plot - ~epanet.plot_close - ~epanet.plot_show - ~epanet.plot_ts - ~epanet.printv - ~epanet.reloadNetwork - ~epanet.runEPANETexe - ~epanet.runHydraulicAnalysis - ~epanet.runQualityAnalysis - ~epanet.runsCompleteSimulation - ~epanet.saveHydraulicFile - ~epanet.saveHydraulicsOutputReportingFile - ~epanet.saveInputFile - ~epanet.setCMDCODE - ~epanet.setControls - ~epanet.setCurve - ~epanet.setCurveComment - ~epanet.setCurveNameID - ~epanet.setCurveValue - ~epanet.setDemandModel - ~epanet.setFlowUnitsAFD - ~epanet.setFlowUnitsCFS - ~epanet.setFlowUnitsCMD - ~epanet.setFlowUnitsCMH - ~epanet.setFlowUnitsGPM - ~epanet.setFlowUnitsIMGD - ~epanet.setFlowUnitsLPM - ~epanet.setFlowUnitsLPS - ~epanet.setFlowUnitsMGD - ~epanet.setFlowUnitsMLD - ~epanet.setLinkBulkReactionCoeff - ~epanet.setLinkComment - ~epanet.setLinkDiameter - ~epanet.setLinkInitialSetting - ~epanet.setLinkInitialStatus - ~epanet.setLinkLength - ~epanet.setLinkMinorLossCoeff - ~epanet.setLinkNameID - ~epanet.setLinkNodesIndex - ~epanet.setLinkPipeData - ~epanet.setLinkPumpECost - ~epanet.setLinkPumpECurve - ~epanet.setLinkPumpEPat - ~epanet.setLinkPumpHCurve - ~epanet.setLinkPumpHeadCurveIndex - ~epanet.setLinkPumpPatternIndex - ~epanet.setLinkPumpPower - ~epanet.setLinkRoughnessCoeff - ~epanet.setLinkSettings - ~epanet.setLinkStatus - ~epanet.setLinkTypePipe - ~epanet.setLinkTypePipeCV - ~epanet.setLinkTypePump - ~epanet.setLinkTypeValveFCV - ~epanet.setLinkTypeValveGPV - ~epanet.setLinkTypeValvePBV - ~epanet.setLinkTypeValvePRV - ~epanet.setLinkTypeValvePSV - ~epanet.setLinkTypeValveTCV - ~epanet.setLinkVertices - ~epanet.setLinkWallReactionCoeff - ~epanet.setNodeBaseDemands - ~epanet.setNodeComment - ~epanet.setNodeCoordinates - ~epanet.setNodeDemandPatternIndex - ~epanet.setNodeElevations - ~epanet.setNodeEmitterCoeff - ~epanet.setNodeInitialQuality - ~epanet.setNodeJunctionData - ~epanet.setNodeJunctionDemandName - ~epanet.setNodeNameID - ~epanet.setNodeSourcePatternIndex - ~epanet.setNodeSourceQuality - ~epanet.setNodeSourceType - ~epanet.setNodeTankBulkReactionCoeff - ~epanet.setNodeTankCanOverFlow - ~epanet.setNodeTankData - ~epanet.setNodeTankDiameter - ~epanet.setNodeTankInitialLevel - ~epanet.setNodeTankMaximumWaterLevel - ~epanet.setNodeTankMinimumWaterLevel - ~epanet.setNodeTankMinimumWaterVolume - ~epanet.setNodeTankMixingFraction - ~epanet.setNodeTankMixingModelType - ~epanet.setNodeTypeJunction - ~epanet.setNodeTypeReservoir - ~epanet.setNodeTypeTank - ~epanet.setNodesConnectingLinksID - ~epanet.setOptionsAccuracyValue - ~epanet.setOptionsCheckFrequency - ~epanet.setOptionsDampLimit - ~epanet.setOptionsDemandCharge - ~epanet.setOptionsEmitterExponent - ~epanet.setOptionsExtraTrials - ~epanet.setOptionsFlowChange - ~epanet.setOptionsGlobalEffic - ~epanet.setOptionsGlobalPattern - ~epanet.setOptionsGlobalPrice - ~epanet.setOptionsHeadError - ~epanet.setOptionsHeadLossFormula - ~epanet.setOptionsLimitingConcentration - ~epanet.setOptionsMaxTrials - ~epanet.setOptionsMaximumCheck - ~epanet.setOptionsPatternDemandMultiplier - ~epanet.setOptionsPipeBulkReactionOrder - ~epanet.setOptionsPipeWallReactionOrder - ~epanet.setOptionsQualityTolerance - ~epanet.setOptionsSpecificDiffusivity - ~epanet.setOptionsSpecificGravity - ~epanet.setOptionsSpecificViscosity - ~epanet.setOptionsTankBulkReactionOrder - ~epanet.setPattern - ~epanet.setPatternComment - ~epanet.setPatternMatrix - ~epanet.setPatternNameID - ~epanet.setPatternValue - ~epanet.setQualityType - ~epanet.setReport - ~epanet.setReportFormatReset - ~epanet.setReportStatus - ~epanet.setRuleElseAction - ~epanet.setRulePremise - ~epanet.setRulePremiseObejctNameID - ~epanet.setRulePremiseStatus - ~epanet.setRulePremiseValue - ~epanet.setRulePriority - ~epanet.setRuleThenAction - ~epanet.setRules - ~epanet.setTimeHydraulicStep - ~epanet.setTimePatternStart - ~epanet.setTimePatternStep - ~epanet.setTimeQualityStep - ~epanet.setTimeReportingStart - ~epanet.setTimeReportingStep - ~epanet.setTimeRuleControlStep - ~epanet.setTimeSimulationDuration - ~epanet.setTimeStatisticsType - ~epanet.setTitle - ~epanet.solveCompleteHydraulics - ~epanet.solveCompleteQuality - ~epanet.splitPipe - ~epanet.stepQualityAnalysisTimeLeft - ~epanet.to_array - ~epanet.to_mat - ~epanet.unload - ~epanet.useHydraulicFile - ~epanet.writeLineInReportFile - ~epanet.writeReport - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~epanet.ControlLevelValues - ~epanet.ControlLinkIndex - ~epanet.ControlNodeIndex - ~epanet.ControlRules - ~epanet.ControlRulesCount - ~epanet.ControlSettings - ~epanet.ControlTypes - ~epanet.ControlTypesIndex - ~epanet.Controls - ~epanet.CurveCount - ~epanet.CurveIndex - ~epanet.CurvesInfo - ~epanet.DEMANDMODEL - ~epanet.DemandModelCode - ~epanet.DemandModelPexp - ~epanet.DemandModelPmin - ~epanet.DemandModelPreq - ~epanet.DemandModelType - ~epanet.EnergyEfficiencyUnits - ~epanet.EnergyUnits - ~epanet.Errcode - ~epanet.InputFile - ~epanet.Iterations - ~epanet.LOGOP - ~epanet.LibEPANET - ~epanet.LibEPANETpath - ~epanet.LinkBulkReactionCoeff - ~epanet.LinkCount - ~epanet.LinkDiameter - ~epanet.LinkFlowUnits - ~epanet.LinkFrictionFactorUnits - ~epanet.LinkIndex - ~epanet.LinkInitialSetting - ~epanet.LinkInitialStatus - ~epanet.LinkLength - ~epanet.LinkLengthsUnits - ~epanet.LinkMinorLossCoeff - ~epanet.LinkMinorLossCoeffUnits - ~epanet.LinkNameID - ~epanet.LinkPipeCount - ~epanet.LinkPipeDiameterUnits - ~epanet.LinkPipeIndex - ~epanet.LinkPipeNameID - ~epanet.LinkPipeRoughnessCoeffUnits - ~epanet.LinkPumpCount - ~epanet.LinkPumpHeadCurveIndex - ~epanet.LinkPumpIndex - ~epanet.LinkPumpNameID - ~epanet.LinkPumpPatternIndex - ~epanet.LinkPumpPatternNameID - ~epanet.LinkPumpPower - ~epanet.LinkPumpPowerUnits - ~epanet.LinkPumpType - ~epanet.LinkPumpTypeCode - ~epanet.LinkRoughnessCoeff - ~epanet.LinkType - ~epanet.LinkTypeIndex - ~epanet.LinkValveCount - ~epanet.LinkValveIndex - ~epanet.LinkValveNameID - ~epanet.LinkVelocityUnits - ~epanet.LinkWallReactionCoeff - ~epanet.NodeBaseDemands - ~epanet.NodeCoordinates - ~epanet.NodeCount - ~epanet.NodeDemandCategoriesNumber - ~epanet.NodeDemandPatternIndex - ~epanet.NodeDemandPatternNameID - ~epanet.NodeDemandUnits - ~epanet.NodeElevationUnits - ~epanet.NodeElevations - ~epanet.NodeEmitterCoeff - ~epanet.NodeEmitterCoefficientUnits - ~epanet.NodeHeadUnits - ~epanet.NodeIndex - ~epanet.NodeInitialQuality - ~epanet.NodeJunctionCount - ~epanet.NodeJunctionIndex - ~epanet.NodeJunctionNameID - ~epanet.NodeNameID - ~epanet.NodePatternIndex - ~epanet.NodePressureUnits - ~epanet.NodeReservoirCount - ~epanet.NodeReservoirIndex - ~epanet.NodeReservoirNameID - ~epanet.NodeSourcePatternIndex - ~epanet.NodeSourceQuality - ~epanet.NodeSourceTypeIndex - ~epanet.NodeTankBulkReactionCoeff - ~epanet.NodeTankCount - ~epanet.NodeTankDiameter - ~epanet.NodeTankDiameterUnits - ~epanet.NodeTankIndex - ~epanet.NodeTankInitialLevel - ~epanet.NodeTankInitialWaterVolume - ~epanet.NodeTankMaximumWaterLevel - ~epanet.NodeTankMaximumWaterVolume - ~epanet.NodeTankMinimumFraction - ~epanet.NodeTankMinimumWaterLevel - ~epanet.NodeTankMinimumWaterVolume - ~epanet.NodeTankMixZoneVolume - ~epanet.NodeTankMixingModelCode - ~epanet.NodeTankMixingModelType - ~epanet.NodeTankNameID - ~epanet.NodeTankReservoirCount - ~epanet.NodeTankVolumeCurveIndex - ~epanet.NodeTankVolumeUnits - ~epanet.NodeType - ~epanet.NodeTypeIndex - ~epanet.NodesConnectingLinksID - ~epanet.NodesConnectingLinksIndex - ~epanet.OptionsAccuracyValue - ~epanet.OptionsEmitterExponent - ~epanet.OptionsFlowChange - ~epanet.OptionsHeadError - ~epanet.OptionsHeadLossFormula - ~epanet.OptionsHydraulics - ~epanet.OptionsMaxTrials - ~epanet.OptionsPattern - ~epanet.OptionsPatternDemandMultiplier - ~epanet.OptionsQualityTolerance - ~epanet.OptionsSpecificGravity - ~epanet.OptionsUnbalanced - ~epanet.OptionsViscosity - ~epanet.Pattern - ~epanet.PatternAverageValue - ~epanet.PatternCount - ~epanet.PatternDemandsUnits - ~epanet.PatternIndex - ~epanet.PatternLengths - ~epanet.PatternNameID - ~epanet.QualityChemName - ~epanet.QualityChemUnits - ~epanet.QualityCode - ~epanet.QualityReactionCoeffBulkUnits - ~epanet.QualityReactionCoeffWallUnits - ~epanet.QualitySourceMassInjectionUnits - ~epanet.QualityTraceNodeIndex - ~epanet.QualityType - ~epanet.QualityUnits - ~epanet.QualityWaterAgeUnits - ~epanet.RULEOBJECT - ~epanet.RULEOPERATOR - ~epanet.RULESTATUS - ~epanet.RULEVARIABLE - ~epanet.RelativeError - ~epanet.TYPEBINSTATUS - ~epanet.TYPECONTROL - ~epanet.TYPECURVE - ~epanet.TYPEHEADLOSS - ~epanet.TYPELINK - ~epanet.TYPEMIXMODEL - ~epanet.TYPENODE - ~epanet.TYPEPUMP - ~epanet.TYPEPUMPSTATE - ~epanet.TYPEQUALITY - ~epanet.TYPEREPORT - ~epanet.TYPESOURCE - ~epanet.TYPESTATS - ~epanet.TYPESTATUS - ~epanet.TYPEUNITS - ~epanet.TempInpFile - ~epanet.TimeHTime - ~epanet.TimeHaltFlag - ~epanet.TimeHydraulicStep - ~epanet.TimeNextEvent - ~epanet.TimePatternStart - ~epanet.TimePatternStep - ~epanet.TimeQualityStep - ~epanet.TimeReportingPeriods - ~epanet.TimeReportingStart - ~epanet.TimeReportingStep - ~epanet.TimeRuleControlStep - ~epanet.TimeSimulationDuration - ~epanet.TimeStartTime - ~epanet.TimeStatisticsIndex - ~epanet.TimeStatisticsType - ~epanet.ToolkitConstants - ~epanet.Units_SI_Metric - ~epanet.Units_US_Customary - ~epanet.Version - ~epanet.libFunctions - - \ No newline at end of file