sir3stoolkit package

Subpackages

• sir3stoolkit.core package
  • Submodules
  • sir3stoolkit.core.wrapper module
    • DotNetEnumMeta
    • Initialize_Toolkit()
    • SIR3S_Model
      • SIR3S_Model.AddNewBypassElement()
      • SIR3S_Model.AddNewConnectingElement()
      • SIR3S_Model.AddNewNode()
      • SIR3S_Model.AddNewPipe()
      • SIR3S_Model.AddTableRow()
      • SIR3S_Model.AlignElement()
      • SIR3S_Model.AllowSirMessageBox()
      • SIR3S_Model.CloseModel()
      • SIR3S_Model.ConnectBypassElementWithNode()
      • SIR3S_Model.ConnectConnectingElementWithNodes()
      • SIR3S_Model.CreateModelRepair()
      • SIR3S_Model.DeleteElement()
      • SIR3S_Model.EnableOrDisableOutputComments()
      • SIR3S_Model.EnableOrDisable_ObjectTypes_TableNames_Enum()
      • SIR3S_Model.EndEditSession()
      • SIR3S_Model.EndTransaction()
      • SIR3S_Model.ExecCalculation()
      • SIR3S_Model.GetCourseOfHydraulicProfile()
      • SIR3S_Model.GetCurrentTimeStamp()
      • SIR3S_Model.GetElementInfo()
      • SIR3S_Model.GetEndNodes()
      • SIR3S_Model.GetGeometryInformation()
      • SIR3S_Model.GetHydraulicProfileObjectString()
      • SIR3S_Model.GetLogFilePath()
      • SIR3S_Model.GetMainContainer()
      • SIR3S_Model.GetMaxResult()
      • SIR3S_Model.GetMaxResult_for_timestamp()
      • SIR3S_Model.GetMinResult()
      • SIR3S_Model.GetMinResult_for_timestamp()
      • SIR3S_Model.GetNetworkType()
      • SIR3S_Model.GetNumberOfElements()
      • SIR3S_Model.GetObjectTypeof_Key()
      • SIR3S_Model.GetPropertiesofElementType()
      • SIR3S_Model.GetResultProperties_from_elementKey()
      • SIR3S_Model.GetResultProperties_from_elementType()
      • SIR3S_Model.GetResultValue()
      • SIR3S_Model.GetResultforAllTimestamp()
      • SIR3S_Model.GetResultfortimestamp()
      • SIR3S_Model.GetTableRows()
      • SIR3S_Model.GetTimeStamps()
      • SIR3S_Model.GetTkFromIDReference()
      • SIR3S_Model.GetTksofElementType()
      • SIR3S_Model.GetValue()
      • SIR3S_Model.InsertElement()
      • SIR3S_Model.IsMainContainer()
      • SIR3S_Model.NewModel()
      • SIR3S_Model.OpenModel()
      • SIR3S_Model.OpenModelXml()
      • SIR3S_Model.RefreshViews()
      • SIR3S_Model.SaveChanges()
      • SIR3S_Model.SetCurrentTimeStamp()
      • SIR3S_Model.SetElementColor()
      • SIR3S_Model.SetElementColor_RGB()
      • SIR3S_Model.SetGeometryInformation()
      • SIR3S_Model.SetInsertPoint()
      • SIR3S_Model.SetLogFilePath()
      • SIR3S_Model.SetValue()
      • SIR3S_Model.StartEditSession()
      • SIR3S_Model.StartTransaction()
      • SIR3S_Model.to_dotnet_enum()
      • SIR3S_Model.to_python_enum()
    • SIR3S_ModelRepair
      • SIR3S_ModelRepair.CheckRepairTool()
      • SIR3S_ModelRepair.ExecuteRepairTool()
      • SIR3S_ModelRepair.GetListOfRepairTool()
    • SIR3S_View
      • SIR3S_View.AddExternalArrow()
      • SIR3S_View.AddExternalEllipse()
      • SIR3S_View.AddExternalPolygon()
      • SIR3S_View.AddExternalPolygonPoint()
      • SIR3S_View.AddExternalPolygon_using_LineString()
      • SIR3S_View.AddExternalPolyline()
      • SIR3S_View.AddExternalPolylinePoint()
      • SIR3S_View.AddExternalPolyline_using_LineString()
      • SIR3S_View.AddExternalRectangle()
      • SIR3S_View.AddExternalText()
      • SIR3S_View.AddNewCustomer()
      • SIR3S_View.AddNewDirectionalArrow()
      • SIR3S_View.AddNewHouse()
      • SIR3S_View.AddNewHydrant()
      • SIR3S_View.AddNewNumericalDisplay()
      • SIR3S_View.AddNewStreet()
      • SIR3S_View.AddNewText()
      • SIR3S_View.AddNewValveOnPipe()
      • SIR3S_View.CloseModel()
      • SIR3S_View.ColoratePipe()
      • SIR3S_View.DoColoration()
      • SIR3S_View.EnableOrDisableOutputComments()
      • SIR3S_View.EndEditSession()
      • SIR3S_View.EndTransaction()
      • SIR3S_View.GetColor()
      • SIR3S_View.GetColorTableEntries()
      • SIR3S_View.GetFont()
      • SIR3S_View.GetMainContainer()
      • SIR3S_View.GetNumericalDisplayProperties()
      • SIR3S_View.GetTextProperties()
      • SIR3S_View.GetWidthFactor()
      • SIR3S_View.InitColorTable()
      • SIR3S_View.MoveElementBy()
      • SIR3S_View.MoveElementTo()
      • SIR3S_View.OpenModel()
      • SIR3S_View.OpenModelXml()
      • SIR3S_View.PrepareColoration()
      • SIR3S_View.RemoveAllExternalVisualObjects()
      • SIR3S_View.ResetColoration()
      • SIR3S_View.SaveChanges()
      • SIR3S_View.SetExternalArrowProperties()
      • SIR3S_View.SetExternalEllipseProperties()
      • SIR3S_View.SetExternalPolyLineWidthAndColor()
      • SIR3S_View.SetExternalPolygonProperties()
      • SIR3S_View.SetExternalRectangleProperties()
      • SIR3S_View.SetExternalTextProperties()
      • SIR3S_View.SetExternalTextText()
      • SIR3S_View.SetFont()
      • SIR3S_View.SetWidthScaleProperties()
      • SIR3S_View.StartEditSession()
      • SIR3S_View.StartTransaction()
      • SIR3S_View.to_dotnet_enum()
      • SIR3S_View.to_python_enum()
    • create_dotnet_enum()
    • fontInformation
      • fontInformation.angle_degree
      • fontInformation.color
      • fontInformation.faceName
      • fontInformation.heightPt
      • fontInformation.isBold
      • fontInformation.isItalic
      • fontInformation.isUnderline
      • fontInformation.textContent
    • hydraulicProfile
      • hydraulicProfile.childrenUID
      • hydraulicProfile.length
      • hydraulicProfile.linksRL
      • hydraulicProfile.linksVL
      • hydraulicProfile.nodesRL
      • hydraulicProfile.nodesVL
      • hydraulicProfile.nrOfBranches
      • hydraulicProfile.tkArticulationNode
      • hydraulicProfile.xOffSet
      • hydraulicProfile.xOffsetRelativeToParent
      • hydraulicProfile.xRL
      • hydraulicProfile.xVL
    • numericalDisplayProperties
      • numericalDisplayProperties.absValue
      • numericalDisplayProperties.angle_degree
      • numericalDisplayProperties.color
      • numericalDisplayProperties.description
      • numericalDisplayProperties.elemPropertyNameOrResult
      • numericalDisplayProperties.faceName
      • numericalDisplayProperties.forResult
      • numericalDisplayProperties.heightPt
      • numericalDisplayProperties.isBold
      • numericalDisplayProperties.isItalic
      • numericalDisplayProperties.isUnderline
      • numericalDisplayProperties.numDec
      • numericalDisplayProperties.prefix
      • numericalDisplayProperties.tkObserved
      • numericalDisplayProperties.unit
      • numericalDisplayProperties.x
      • numericalDisplayProperties.y
    • textProperties
      • textProperties.angle_degree
      • textProperties.color
      • textProperties.description
      • textProperties.faceName
      • textProperties.heightPt
      • textProperties.idRef
      • textProperties.isBold
      • textProperties.isItalic
      • textProperties.isUnderline
      • textProperties.textContent
      • textProperties.x
      • textProperties.y
  • Module contents
• sir3stoolkit.mantle package
  • Submodules
  • sir3stoolkit.mantle.advanced_operations module
    • SIR3S_Model_Advanced_Operations
      • SIR3S_Model_Advanced_Operations.add_element_types_to_tk_list()
      • SIR3S_Model_Advanced_Operations.add_elements_to_group()
      • SIR3S_Model_Advanced_Operations.get_element_type_from_tk()
      • SIR3S_Model_Advanced_Operations.get_tks_of_group_elements()
      • SIR3S_Model_Advanced_Operations.remove_elements_from_group()
      • SIR3S_Model_Advanced_Operations.set_group_elements()
  • sir3stoolkit.mantle.alternative_models module
    • SIR3S_Model_Alternative_Models
      • SIR3S_Model_Alternative_Models.SIR_3S_to_nx_graph()
      • SIR3S_Model_Alternative_Models.SIR_3S_to_pandapipes()
      • SIR3S_Model_Alternative_Models.add_properties_to_graph()
      • SIR3S_Model_Alternative_Models.get_object_type_enum()
  • sir3stoolkit.mantle.dataframes module
    • SIR3S_Model_Dataframes
      • SIR3S_Model_Dataframes.add_interior_points_as_flat_cols()
      • SIR3S_Model_Dataframes.add_interior_points_as_multiindex()
      • SIR3S_Model_Dataframes.add_interior_points_to_start_end_sequence()
      • SIR3S_Model_Dataframes.delete_elements_in_dataframe()
      • SIR3S_Model_Dataframes.generate_edge_dataframe()
      • SIR3S_Model_Dataframes.generate_element_dataframe()
      • SIR3S_Model_Dataframes.generate_element_model_data_dataframe()
      • SIR3S_Model_Dataframes.generate_element_results_dataframe()
      • SIR3S_Model_Dataframes.generate_longitudinal_section_dataframes()
      • SIR3S_Model_Dataframes.get_EPSG()
      • SIR3S_Model_Dataframes.get_dataframe_from_time_table()
      • SIR3S_Model_Dataframes.get_dataframes_from_nominal_diameter_tables()
      • SIR3S_Model_Dataframes.get_dataframes_from_time_table_type()
      • SIR3S_Model_Dataframes.insert_dataframe_into_time_table()
      • SIR3S_Model_Dataframes.merge_model_data_and_results()
  • sir3stoolkit.mantle.mantle module
    • SIR3S_Model_Mantle
  • sir3stoolkit.mantle.plotting module
    • SIR3S_Model_Plotting
      • SIR3S_Model_Plotting.plot_node_layer()
      • SIR3S_Model_Plotting.plot_pipe_layer()
      • SIR3S_Model_Plotting.plot_time_curves()
  • Module contents

Submodules

sir3stoolkit.logging_utils module

sir3stoolkit.logging_utils.emit_message(logger: Logger, message) → None

Emit a legacy message with level inference.

sir3stoolkit.logging_utils.get_logger(name: str) → Logger

Create/get module logger with a host-aware fallback print handler.

sir3stoolkit.logging_utils.get_process_executable_name() → str

Get executable name of current process when available.

sir3stoolkit.logging_utils.get_process_executable_path() → str | None

Get absolute path to current process executable when available.

sir3stoolkit.logging_utils.is_host_process() → bool

Return True when running inside SirGraf host process.

Module contents