RS2Scripting 11.23.0.dev1__py3-none-any.whl → 11.23.0.dev3__py3-none-any.whl

{RS2Scripting-11.23.0.dev1.dist-info → RS2Scripting-11.23.0.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: RS2Scripting
-Version: 11.23.0.dev1
+Version: 11.23.0.dev3
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License

{RS2Scripting-11.23.0.dev1.dist-info → RS2Scripting-11.23.0.dev3.dist-info}/RECORD

@@ -4,22 +4,22 @@ rs2/_common/ProxyObject.py,sha256=6c6AJPTTAR7dSBowNhw2OzizAFNHixkRy8sQRv8gqlU,47
 rs2/_common/Units.py,sha256=T0JYsYuxtc2b59_I83GztMETmssqOXI-oQ-KREfgMm8,202
 rs2/_common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/_common/documentProxy.py,sha256=W1a2uezHNIG0VXjF1IODN680j0q-hzAH2WEwe0xCKW8,182
-rs2/interpreter/BoltResult.py,sha256=tuV-EU3V9t2rO4aokUAdXZ3FXTrFXMbZpjFvUV_5pK4,1896
-rs2/interpreter/CompositeResult.py,sha256=oEm4eR5wJFdjm2h3IENmVeybzOU1eLokKxmgbH9R-v0,636
+rs2/interpreter/BoltResult.py,sha256=hspIW08yEqH7nXwyvagPsX8SKU_A--wCeLotapvSePw,1994
+rs2/interpreter/CompositeResult.py,sha256=IvCxvSJvBwe1fn_ZQhN3823RUIWDTyWbjxyACszPijc,896
 rs2/interpreter/HistoryQueryResults.py,sha256=7HjZL8mLqNW-apVOhY42Jxo-uMFWzTH_meAwjuEXBMg,956
 rs2/interpreter/InterpreterEnums.py,sha256=LLf6L3t4EdlqTAvV6yEpwGyZTd3Ph-perIKyfLfRbC4,5468
 rs2/interpreter/InterpreterGraphEnums.py,sha256=EzhwBih2TC7Us5NY2GTL6W0_7wsIWi1NDv16Jjl6AC8,1757
-rs2/interpreter/InterpreterModelProxy.py,sha256=juPFZHbdACk-8exL_wNq537SjSM1aWejPi4Xmanp8o8,16306
-rs2/interpreter/JointResult.py,sha256=xP0f4D4_CR7lkTKw9Z101M_I8IKwzpJ3Jomx6_25RGs,897
-rs2/interpreter/LinerResult.py,sha256=hMFXXRaW-v5omEsW_4EEag4qgsfbWsV-ai2TASvoDig,1417
+rs2/interpreter/InterpreterModel.py,sha256=7hqSRzTQxQp0awQJ9Y3k_ZF-5fcZy1gPMhROkmTcQN8,12964
+rs2/interpreter/JointResult.py,sha256=vW04g5hdvkbWaAew6tNmCSeNp-1ecRyIjs_DhbGiJP4,937
+rs2/interpreter/LinerResult.py,sha256=yZpw6ceJNYGDeu8a4iAHJPYFtKeN0xDRDwgmMT2TKE8,1457
 rs2/interpreter/MaterialQueryResults.py,sha256=xlHpPQ0VvysyPkJekP6OU0HPJlSUBo0HEHIvFgZHvUI,2099
-rs2/interpreter/MeshResults.py,sha256=nfx5NcpGGMow6n-IfmshYd7sHp_gxFkCWcj21w62eiQ,333
-rs2/interpreter/RS2Interpreter.py,sha256=rhjnf91sAnmY5R7UeAIr5yJfrdYmRc7AmpFCEjPIug8,3028
+rs2/interpreter/MeshResults.py,sha256=Chwg2Tp7cYuhSpeEmR96TCXUgsdevidWHBI7JQ9yIsI,333
+rs2/interpreter/RS2Interpreter.py,sha256=JOtwxV_EMBBhJwi57HhyOF1rBH1VeGI_U65VVLf6siM,2998
 rs2/interpreter/TimeQueryResults.py,sha256=uZxpJQsRsEY4c2nkTs4NYl4LFVAe7MK2AVKZb2UGohg,4231
 rs2/interpreter/UtilityResult.py,sha256=6VsLAdwxXuXyR7a7yAJ-6axxSqSURk92HDDVnyPcZsU,500
 rs2/interpreter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rs2/modeler/ModelProxy.py,sha256=kiE5l3GdCoFHMhrSqqeid0X-5v7M-brVRdbSD9BIyCE,15161
-rs2/modeler/RS2Modeler.py,sha256=ZXauOcO2Pz9e0EedAbkoiOQA0octHtBa3VVwisbTa6g,3024
+rs2/modeler/Model.py,sha256=pK-8GRjMh29KcWuWwJi2n0J-dCsfKhB22Asj7bo4-tg,14875
+rs2/modeler/RS2Modeler.py,sha256=vISeaUuktlqG4wMPmXvUs1YgB7LIc2m7eoAgY5IF0DQ,2994
 rs2/modeler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/AbsoluteStageFactorGettersInterface.py,sha256=HpsdM0TBPgZ_wfwyC0pY87PnFZWbbwSBWpwqh8vzBQo,1475
 rs2/modeler/properties/AbsoluteStageFactorInterface.py,sha256=QM0T-oJUoSzTXIoExRGvg6avEsmNRoazKsUE_gv1IXI,2382
@@ -29,7 +29,7 @@ rs2/modeler/properties/MaterialJoint.py,sha256=PHs9oGfNoQG8pr6y8WnFyt9gDu_Qovfgw
 rs2/modeler/properties/MaterialJointOptions.py,sha256=8Tf1MZZ7nEN581Abq16nX6kLISP65KgsVsyn-E7ICQM,1806
 rs2/modeler/properties/PropertyEnums.py,sha256=CaLg0H6OM90BIB3mM2kzhy1Q0k8JEX-5f5ujAaZuSQI,15313
 rs2/modeler/properties/RelativeStageFactorInterface.py,sha256=ijkFvOQbZWEAT1Ecc8nFx80iQAvAAFj7pzZrPiZzs2I,2702
-rs2/modeler/properties/ShearNormalFunctionProxy.py,sha256=zDI6jm7X_tebNa-GSquGKuNR5J6BSWqXNoVYHv6DG6w,2551
+rs2/modeler/properties/ShearNormalFunction.py,sha256=zDI6jm7X_tebNa-GSquGKuNR5J6BSWqXNoVYHv6DG6w,2551
 rs2/modeler/properties/SnowdenAnisotropicFunction.py,sha256=0_65PkquiDTvxhs03tSJZQhwG2fgHHXjgx7_3Ss-J0w,3151
 rs2/modeler/properties/StructuralInterface.py,sha256=IbsTskaZJA_1kf8vZo4RkjZAwDmsKMvOpgfS0C-qJ6U,1957
 rs2/modeler/properties/UserDefinedWaterMode.py,sha256=1LlVp4e3eUflQ5RFEJIcjna79kyZweOwOv-afwJrQ7I,1284
@@ -61,7 +61,7 @@ rs2/modeler/properties/liner/ReinforcedConcrete.py,sha256=uP-fMC5mKsWrn5tIxf22Zh
 rs2/modeler/properties/liner/StandardBeam.py,sha256=E6TlKqybZJbCdh-k2KEsbY0ljSofw8Te5EvMWZUIMLY,17424
 rs2/modeler/properties/liner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/InitialConditions.py,sha256=7NcB11DhNJ8g3FSXCeYr2kQK4zcJZlBqq92PCzbRSGU,9142
-rs2/modeler/properties/material/MaterialPropertyProxy.py,sha256=7f2iHM6m4K-rrf7wqIM_FHUOzEAIRoMjqRABv2cOx2c,3054
+rs2/modeler/properties/material/MaterialProperty.py,sha256=7f2iHM6m4K-rrf7wqIM_FHUOzEAIRoMjqRABv2cOx2c,3054
 rs2/modeler/properties/material/StageFactors.py,sha256=JP70Ow79AKra3yrQpNGFnCOdWk9cGWaWV2HQguS9pcc,6165
 rs2/modeler/properties/material/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/datum/BaseDatum.py,sha256=t4DlusPp6zYfmgIQOCQ--LtEiBkygCR8ipQCfZ7V0KI,949
@@ -69,8 +69,8 @@ rs2/modeler/properties/material/datum/Datum.py,sha256=uAjFf1GKP4FcClricpPn0zZmei
 rs2/modeler/properties/material/datum/PeakResidualDatum.py,sha256=mt5pO3q5quq0UMCEPZyDJLlnvewAjX8HYLLn7Uqg-Dw,1531
 rs2/modeler/properties/material/datum/SimpleDatum.py,sha256=J9CpDpY3UGmDYzO6RhAbZcReCOfG3JzEwD86i_tgXN4,773
 rs2/modeler/properties/material/datum/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rs2/modeler/properties/material/hydraulic/Hydraulic.py,sha256=YWBa2gNTM6_kXYTpMKqGJ6lD7RqFoQ0uCreKWhmPSbU,2569
-rs2/modeler/properties/material/hydraulic/StaticGroundwater.py,sha256=y245TPX5k2BX_sCfuynIdpRW9PGxRB6W6cXRiF2Ou4g,4255
+rs2/modeler/properties/material/hydraulic/Hydraulic.py,sha256=Spb0hRzljC1s5JJx6fL1IMRZForsALh2qcjasj0j_D8,2559
+rs2/modeler/properties/material/hydraulic/StaticGroundwater.py,sha256=Hs5GzrX-cOGZAEzUdiMhUh6zhH2-tVdWqvWqcKC_nRo,4322
 rs2/modeler/properties/material/hydraulic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/hydraulic/FEAGroundwater/Brooks.py,sha256=egniL7URWGMkhDuRJUdwoYtUfZEEtymjiXjupwdPEYo,5922
 rs2/modeler/properties/material/hydraulic/FEAGroundwater/Constant.py,sha256=T0HHiFgxJB4jSoOarcYKP9G9X70aNfJq9zVUGSIo9As,2659
@@ -141,7 +141,7 @@ rs2/modeler/properties/material/strength/VerticalStressRatio.py,sha256=OH0JKEClw
 rs2/modeler/properties/material/strength/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/thermal/Thermal.py,sha256=Tdhj9Yy_15F-6TRMvk6Ndw6N5EY6OpJDmwAED013gPU,4624
 rs2/modeler/properties/material/thermal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rs2/modeler/properties/material/thermal/conductivity/Conductivity.py,sha256=Hv2wcQ-XKCckBsUyDPyyfIxHfu8L5K5JFxPoULatSR0,1563
+rs2/modeler/properties/material/thermal/conductivity/Conductivity.py,sha256=ghX8mZuV9TJDVunD3Ag38Tcn9xWO6NB-0X-Rt-u77yY,1550
 rs2/modeler/properties/material/thermal/conductivity/ConstantConductivity.py,sha256=joHkJpIp5qJapbpfEjoCNTfOeB9KZbnUyuLYIsm0oQ8,1678
 rs2/modeler/properties/material/thermal/conductivity/CoteAndKonrad.py,sha256=5jE6xHfr7VSETkcfLu6aj7lN1wK5ZKUuWZqv6Nlmt7U,2103
 rs2/modeler/properties/material/thermal/conductivity/Derives.py,sha256=qB1bBJAZYejzoSkOhrz40ZNBTAX31I--8nvOJF4NyFA,779
@@ -151,19 +151,19 @@ rs2/modeler/properties/material/thermal/conductivity/Tabular.py,sha256=9YxNddxSg
 rs2/modeler/properties/material/thermal/conductivity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/thermal/heatcapacity/ConstantHeatCapacity.py,sha256=Ro2lcuxFh2PvGQyqyCtknGGr5tHYkSkRlX3RYnpOWSk,2349
 rs2/modeler/properties/material/thermal/heatcapacity/CustomHeatCapacity.py,sha256=2VoKmyDxsDgk077-ojrFp_VsZ9o1mXwNmmoojFcvZZE,2281
-rs2/modeler/properties/material/thermal/heatcapacity/HeatCapacity.py,sha256=cZwZYqP7_7RUdSFi3MyPk6HG7_ggI8P63LTNsDuoRKg,1252
+rs2/modeler/properties/material/thermal/heatcapacity/HeatCapacity.py,sha256=fLkrJD2479ET-UM5cZM2GBLIP7lWzr0f90XVoInDL2A,1239
 rs2/modeler/properties/material/thermal/heatcapacity/JameNewman.py,sha256=Wk-kaAhtbTQMvM3hHqd054jn3w5cT51qs0fF8S5cQGM,1218
 rs2/modeler/properties/material/thermal/heatcapacity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/CustomWaterContent.py,sha256=9nCQy4N3JFoG2kKvXZLn3L7YOEC3NrLQGlWQ7MGW17o,730
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/Konrad.py,sha256=pTeQCNvpv9KDY6PvpfxWRBw3W5HG8xZRoAeJbWUf5x0,1793
-rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/SoilUnfrozenWaterContent.py,sha256=-ulm9xm5CXSsXPUBYaAiznmqWi5yLX774Au4AAql75c,1451
+rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/SoilUnfrozenWaterContent.py,sha256=w-4U-kDNrZ--6i0zevKgJDPGrph_9oWhWWTMltsMQlM,1426
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/TiceAnderson.py,sha256=YQBgKHdSCsRenDRu1sAizCFZjFdLrrSKFuFrH9vrztQ,1501
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/BrooksWaterContent.py,sha256=VLsn66kichFIo6gDEAPhl0GVv-XIPr-t9wTLhhZCIOE,1151
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/FredlundWaterContent.py,sha256=ROqhE3DGzFutIYgNZzHrgrelD75Olg69l0mClGzwAWs,1275
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/GardnerWaterContent.py,sha256=R66IgVCDyCy62xrYjisU11AYe6FajXdJEK3tOBk2sHY,921
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/GenuchtenWaterContent.py,sha256=2zqNiN7kix9uxneCZzAwQuwnouQjEVK7QKEJGAZHvdo,1660
-rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/HydraulicModel.py,sha256=wBBGaONA6hWcH-BQlf7VF0Suds2ZCGP4zYdUQVcza9Y,2434
+rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/HydraulicModel.py,sha256=K0eMyootJKZIYfVyacpeg4dKEsK9es5XwqGhmHnYKnI,2394
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/SimpleWaterContent.py,sha256=R8Yd1sPfgdRNPvAcqQYGVyWGYxWNeQXeGMA4g798zPs,815
 rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rs2/modeler/properties/pile/Beam.py,sha256=VljEyMqHGdEDLFqL7BerXUrLvt7L8t_fHnH0Oaq085k,1460
@@ -178,8 +178,8 @@ rs2/modeler/properties/pile/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 rs2/utilities/ApplicationManager.py,sha256=u2GS_nW6uJcBcOc_CN5yy1DaBU5CF3yOtFGpJC7tdE4,2586
 rs2/utilities/ColorPicker.py,sha256=nOHwCHtn8p3KkVC-GSpa38AOhRh2urQVE3brViH3vzE,2534
 rs2/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-RS2Scripting-11.23.0.dev1.dist-info/License.txt,sha256=_OkJXIBSGMEg07z5G3WiNn3yWOvhXK___X7MHTWR17E,1077
-RS2Scripting-11.23.0.dev1.dist-info/METADATA,sha256=NWf6FfcF6k5gfB5YrGzy33zgoax4HZNpH_dwNd070Hc,9688
-RS2Scripting-11.23.0.dev1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-RS2Scripting-11.23.0.dev1.dist-info/top_level.txt,sha256=9QT-lM7XOqDZtjDEtW-lpH9z4TZPnuq4_4rYcR1W8jM,4
-RS2Scripting-11.23.0.dev1.dist-info/RECORD,,
+RS2Scripting-11.23.0.dev3.dist-info/License.txt,sha256=_OkJXIBSGMEg07z5G3WiNn3yWOvhXK___X7MHTWR17E,1077
+RS2Scripting-11.23.0.dev3.dist-info/METADATA,sha256=qzkV_SmY2RbGWORwoktiZnXhaGCAw02QYjSujsBGejM,9688
+RS2Scripting-11.23.0.dev3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+RS2Scripting-11.23.0.dev3.dist-info/top_level.txt,sha256=9QT-lM7XOqDZtjDEtW-lpH9z4TZPnuq4_4rYcR1W8jM,4
+RS2Scripting-11.23.0.dev3.dist-info/RECORD,,

rs2/interpreter/BoltResult.py

@@ -32,7 +32,7 @@ class BoltForceDisplacementResult:
         ResetInvalid.validate(self)
 
 class BoltResult:
-    def __init__(self, entity_id, entity_data, yielding_results, force_displacement_results):
+    def __init__(self, entity_id, entity_data, yielding_results: BoltYieldingResult, force_displacement_results: BoltForceDisplacementResult):
         if len(entity_data) == 0 or len(entity_data[0]) == 0:
             assert False, 'location not defined'
             return
@@ -44,6 +44,6 @@ class BoltResult:
         self.start_y = start_y
         self.end_x = end_x
         self.end_y = end_y
-        self.yielding_results = yielding_results
-        self.force_displacement_results = force_displacement_results
+        self.yielding_results: BoltYieldingResult = yielding_results
+        self.force_displacement_results: BoltForceDisplacementResult = force_displacement_results
 

rs2/interpreter/CompositeResult.py

@@ -1,22 +1,23 @@
-
+from rs2.interpreter.LinerResult import LinerResult
+from rs2.interpreter.JointResult import JointResult
 
 class PileResult:
-    def __init__(self, entity_id, joint_result, liner_result):
+    def __init__(self, entity_id, joint_result: JointResult, liner_result: LinerResult):
         self.entity_id = entity_id
-        self.joint_result = joint_result
-        self.liner_result = liner_result
+        self.joint_result: JointResult = joint_result
+        self.liner_result: LinerResult = liner_result
 
 class CompositeResult:
-    def __init__(self, entity_id, joint_result, liner_result):
+    def __init__(self, entity_id, joint_result: JointResult, liner_result: LinerResult):
         self.entity_id = entity_id
-        self.joint_result = joint_result
-        self.liner_result = liner_result
+        self.joint_result: JointResult = joint_result
+        self.liner_result: LinerResult = liner_result
 
 class StructuralResult:
-    def __init__(self, entity_id, joint_result, liner_result):
+    def __init__(self, entity_id, joint_result: JointResult, liner_result: LinerResult):
         self.entity_id = entity_id
-        self.joint_result = joint_result
-        self.liner_result = liner_result
+        self.joint_result: JointResult = joint_result
+        self.liner_result: LinerResult = liner_result
 
 
 

rs2/interpreter/{InterpreterModelProxy.py → InterpreterModel.py}

@@ -11,7 +11,7 @@ from rs2.interpreter.LinerResult import *
 from rs2.interpreter.BoltResult import*
 from rs2.interpreter.CompositeResult import*
 from rs2.interpreter.MaterialQueryResults import *
-class ModelProxy(ProxyObject):
+class Model(ProxyObject):
 	"""
 	:ref:`Model Example`
 	"""
@@ -25,7 +25,10 @@ class ModelProxy(ProxyObject):
 
 	def close(self):
 		'''
-		Closes the model
+		:ref:`Model Example`
+
+		|  Closes the model
+		
 		'''
 		return self._callFunction('close', [])
 
@@ -44,23 +47,26 @@ class ModelProxy(ProxyObject):
 
 	def save(self):
 		'''
-		Saves the model
+		:ref:`Model Example`
+
+		|  Saves the model
+
 		'''
 		return self._callFunction('save', [])
 	
 	def SetActiveStage(self, stageNumber: int):
 		'''
-		Change model's active stage by its stage number
+		:ref:`Material Query Example`
+
+		|  Change model's active stage by its stage number
 		'''
 		return self._callFunction('SetActiveStage', [stageNumber])
 	
 	def SetResultType(self, resultType: ExportResultType) -> list[dict]:
 		"""
-		Sets the export result type for the model.
+		:ref:`Get Mesh Results Example`
 
-		Args:
-			resultType (ExportResultType): Takes an enum of type ExportResultType representing the desired
-				export option for mesh results.
+		|  Sets the export result type for your model.
 		
 		Raises:
 			ValueError: resultType must be an enum of type ExportResultType. Any other value will raise an error
@@ -70,33 +76,16 @@ class ModelProxy(ProxyObject):
 	
 	def SetUserDefinedResultType(self, resultName: str) -> list[dict]:
 		"""
-		Sets the export result type to the user defined result type name.
-
-		Args:
-			resultName (str): Takes the name of the user defined export option to generate mesh results for.
+		|  Sets the export result type to the user defined result type name.
 		
 		"""
 		return self._callFunction('SetUserDefinedResultType', [resultName])
 	
 	def GetMeshResults(self) -> MeshResults:
 		"""
-		Returns the mesh results at all nodes of the model.
-
-		Returns:
-			|  An object of type MeshResults. To extract the x-coordinate, y-coordinate or value from the returned data, 
-			|  please call the supported functions from the class:
-			|  MeshResults.GetXCoordinate(index)
-			|  MeshResults.GetYCoordinate(index)
-			|  MeshResults.GetValue(index)
-				
-		Example:
-
-		.. code-block:: python
+		:ref:`Get Mesh Results Example`
 
-			results = model.GetMeshResults()
-			x_coordiante = results.GetXCoordinate(0)
-			y_coordinate = results.GetYCoordinate(0)
-			value = results.GetValue(0)
+		|  Returns the mesh results at all nodes for your model.
 		
 		"""
 		results = self._callFunction('GetMeshResults', [])
@@ -105,38 +94,14 @@ class ModelProxy(ProxyObject):
 	def GetHistoryQueryResults(self, hq_name: str, horizontal_axis: HistoryQueryGraphEnums.HorizontalAxisTypes, vertical_axis: HistoryQueryGraphEnums.VerticalAxisTypes, 
 							stages: list[int]) -> dict[int, list[HistoryQueryResult]]:
 		"""
-		Returns the history query result for the provided query name with specified graph options and stages.
+		:ref:`History Query Example`
 
-		Args:
-			hq_name (str): Takes the name of the History Query Point.
-			horizontal_axis (HistoryQueryGraphEnums): Takes the horizontal axis to generate results for.
-			vertical_axis (HistoryQueryGraphEnums): Takes the vertical axis to generate results for.
-			stages (int): Takes the stages by their stage number for which results should be returned.
-		
-		Returns:
-			|  Returns a dictionary with key as stage number and value a List of HistoryQueryResult object.
-			|  To extract the stage number, x-coordinate, y-coordinate, horizontal axis result and vertical axis result,
-			|  please call the supported functions from the class:
-
-			* GetXCoordinate()
-			* GetYCoordinate()
-			* GetHorizontalAxisResult()
-			* GetVerticalAxisResult()
-		
-		Example:
-
-		.. code-block:: python
-
-			results = model.GetHistoryQueryResults(params)
-			results_for_stage_1 = results[1]
-			x_coordiante = results_for_stage_1[0].GetXCoordinate()
-			y_coordinate = results_for_stage_1[0].GetYCoordinate()
-			horizontal_result = results_for_stage_1[0].GetHorizontalResult()
-			vertical_result = results_for_stage_1[0].GetVerticalResult()
+		|   Returns a map of HistoryQueryResult for all input stages and history queries in your model.
 		
 		Raises:
 			ValueError: horizontal_axis and vertical_axis must be an enum of type HistoryQueryGraphEnums.
 						Any other value will raise an error.
+
 		"""
 		map_data = self._callFunction('GetHistoryQueryResults', [hq_name, horizontal_axis.value, vertical_axis.value, stages])
 		structured_data = {}
@@ -153,35 +118,15 @@ class ModelProxy(ProxyObject):
 							  vertical_axis: TimeQueryGraphEnums.VerticalAxisTypes
 							  ) -> dict[int, list[TimeQueryPointResults]]:
 		"""
-		Returns the results for all the time query points defined in the model for given stages and graph axes type.
-
-		Please note points that are over an excavation at specific stages will not have data returned at those locations.
+		:ref:`Time Query Example`
 
-		Args:
-			stages (list[int]): Takes the stages by their stage number for which results should be returned.
-			vertical_axis (TimeQueryGraphEnums): Takes the vertical axis to generate results for.
-		
-		Returns:
-			| Returns a dictionary with key as stage number and value a list[TimeQueryPointResults] object.
-			| To extract the unique identifier, x-coordinate, y-coordinate, horizontal axis result and vertical axis result,
-			| please call the supported functions from the class:
-
-			* TimeQueryPointResults.GetUniqueIdentifier()
-			
-			To get all the results for this query, please call:
+		|  Returns a map of TimeQueryPointResults for all input stages and time query points in your model.
 
-			* TimeQueryPointResults.GetAllValues()
-		
-		The above method returns list[QueryPointResult] for each node. 
-		To get the x-coordiante, y-coordinate, dynamic stage time or value, please call:
-		
-		* QueryPointResult.GetXCoordinate()
-		* QueryPointResult.GetYCoordinate()
-		* QueryPointResult.GetStageTime()
-		* QueryPointResult.GetValue()
+		|  Please note points that are over an excavation at specific stages will not have data returned at those locations.
 		
 		Raises:
 			ValueError: vertical_axis must be an enum of type TimeQueryGraphEnums. Any other value will raise an error.
+
 		"""
 		map_data = self._callFunction('GetAllTimeQueryPointsResults', 
 							 [stages, vertical_axis.value])
@@ -202,37 +147,15 @@ class ModelProxy(ProxyObject):
 							  apply_post_process_scaling: bool
 							  ) -> dict[int, list[TimeQueryLineResults]]:
 		"""
-		Returns the results for all the time query lines defined in the model for given stages and graph axes types.
+		:ref:`Time Query Example`
 
-		Please note points that are over an excavation at specific stages will not have data returned at those locations.
+		|  Returns a map of TimeQueryLineResults for all input stages and time query lines in your model.
 
-		Args:
-			stages (list[int]): Takes the stages by their stage number for which results should be returned.
-			vertical_axis (TimeQueryGraphEnums): Takes the vertical axis to generate results for.
-			apply_post_process_scaling (bool): Bool input taking whether post-process scaling should be applied or not
-		
-		Returns:
-			|  Returns a dictionary with key as stage number and value a list[TimeQueryLineResults] object.
-			|  To extract the unique identifier, or list[QueryLineResult] representing all node objects for this query line,
-			|  please call the supported functions from the class:
-
-			* TimeQueryLineResults.GetUniqueIdentifier()
-			* TimeQueryLineResults.GetAllNodeObjects()
-
-			|  To get list[QueryPointResult] denoting all the node objects at a specific node of time query line, please call:
-
-			* QueryLineResult.GetNodeValues()
-
-			|  The above method returns list[QueryPointResult] representing all the values at this node of the time query line. 
-			|  To get the x-coordiante, y-coordinate, dynamic stage time or value, please call:
-
-			* QueryPointResult.GetXCoordinate()
-			* QueryPointResult.GetYCoordinate()
-			* QueryPointResult.GetStageTime()
-			* QueryPointResult.GetValue()
+		|  Please note points that are over an excavation at specific stages will not have data returned at those locations.
 		
 		Raises:
 			ValueError: vertical_axis must be an enum of type TimeQueryGraphEnums. Any other value will raise an error.
+
 		"""
 		map_data =  self._callFunction('GetAllTimeQueryLinesResults', 
 							 [stages, vertical_axis.value, apply_post_process_scaling])
@@ -249,49 +172,36 @@ class ModelProxy(ProxyObject):
 		return structured_data	
 	
 	def AddMaterialQuery(self, points: list[list[float]]) -> str:
-		"""Adds a material query point/line to your model using the specified coordinates in order.
+		"""
+		:ref:`Material Query Example`
+
+		|  Adds a material query point/line to your model using the specified coordinates in order.
 
-		Returns:
-			A unique identifier for the newly added material query point/line.
+		|  Returns a unique identifier for the newly added material query point/line.
 		
 		"""
 		return self._callFunction('AddMaterialQuery', [points])
 	
 	def RemoveMaterialQuery(self, IDs_toRemove: list[str]) -> str:
-		"""Removes material query points or lines for provided list of IDs."""
+		"""
+		:ref:`Material Query Example`
+
+		|  Removes material query points or lines for provided list of IDs.
+
+		"""
 		return self._callFunction('RemoveMaterialQuery', [IDs_toRemove])
 	
 	def GetMaterialQueryResults(self) -> list[MaterialQueryResults]:
 		"""
+		:ref:`Material Query Example`
 		
-		|  Returns the results for all the material queries defined in the model for active model stage and result type.
+		|  Returns the results for all the material queries defined in your model for active model stage and result type.
 		|  To get results for a different stage, please call SetActiveStage(int stageNumber) before calling this function.
 		|  To get results for a different result type, please call either before calling this function:
 
 		* SetResultType(InterpreterGraphEnums resultType)
 		* SetUserDefinedResultType("Your defined resultType name")
 
-		Returns: 
-			|  A list[MaterialQueryResults] of query results.
-			|  To extract the Unique Identifier, Material ID for a specific material query object,
-
-			please call any of the supported functions from the class:
-
-			* MaterialQueryResults.GetUniqueIdentifier()
-			* MaterialQueryResults.GetMaterialID()
-
-			|  To get all the results for this query, please call:
-
-			* MaterialQueryResults.GetAllValues()
-
-			|  The above method returns list[QueryResult] for each result. 
-			|  To get the x-coordiante, y-coordinate, distance or value, please call:
-
-			* QueryResult.GetXCoordinate()
-			* QueryResult.GetYCoordinate()
-			* QueryResult.GetDistance()
-			* QueryResult.GetValue()
-
 		"""
 		all_material_query_data = self._callFunction('GetMaterialQueryResults', [])
 		all_mat_query_data_as_classObj = []
@@ -302,12 +212,13 @@ class ModelProxy(ProxyObject):
 			all_mat_query_data_as_classObj.append(MaterialQueryResults(*unpack_list_data))
 		return all_mat_query_data_as_classObj
 
-	
+	def GetBoltResults (self, stages: list[int]) -> dict[int, list[BoltResult]]:
+		"""
+		:ref:`Support Bolt Results Example`
 		
+		|  Returns a map of BoltResult for all input stages and support bolt defined in your model.
 
-	def GetBoltResults (
-		self, 
-		stages: list[int]) -> dict[int, list[BoltResult]]:
+		"""
 		map_data = self._callFunction('GetBoltResults', [stages])
 		structured_data = {}
 		for stage_idx, stage_data in map_data.items():
@@ -320,7 +231,8 @@ class ModelProxy(ProxyObject):
 				# displacement force
 				if len(entity_data) < 3 or len(entity_data[0]) <1 or len(entity_data[0][0]) < 4:
 					continue
-
+				if len(entity_data[1]) < 1 or len(entity_data[2]) < 1:
+					continue
 				for yeilding_vector in entity_data[1]:
 					yielding = BoltYieldingResult(*yeilding_vector)
 					yielding_results.append(yielding)
@@ -332,7 +244,7 @@ class ModelProxy(ProxyObject):
 				structured_data[stage_idx].append(bolt_result)
 		return structured_data
 		
-	def process_joint_data(self, entity_data, entity_name):
+	def _process_joint_data(self, entity_data, entity_name):
 
 		joint_element_results = []
 		for joint_vector in entity_data[1]:
@@ -342,7 +254,7 @@ class ModelProxy(ProxyObject):
 		joint_result = JointResult(entity_name, joint_element_results)
 		return joint_result
 
-	def process_liner_data(self, entity_data, entity_name):
+	def _process_liner_data(self, entity_data, entity_name):
 		liner_element_results = []
 
 		for liner_vector in entity_data[0]:
@@ -351,52 +263,68 @@ class ModelProxy(ProxyObject):
 		liner_result = LinerResult(entity_name,liner_element_results)
 		return liner_result
 
-	def GetJointResults(
-		self, 
-		stages: list[int]) -> dict[int, list[JointResult]]:
+	def GetJointResults(self, stages: list[int]) -> dict[int, list[JointResult]]:
+		"""
+		:ref:`Support Joint Results Example`
+		
+		|  Returns a map of JointResult for all input stages and support joint defined in your model.
 
+		"""
 		map_data = self._callFunction('GetJointResults', [stages])
 		structured_data = {}
 		for stage_idx, stage_data in map_data.items():
 
 			structured_data[stage_idx] = []
 			for entity_name, entity_data in stage_data.items():
-				joint_result = self.process_joint_data(entity_data, entity_name)
+				joint_result = self._process_joint_data(entity_data, entity_name)
 				structured_data[stage_idx].append(joint_result)
 		
 		return structured_data
 	
-	def GetLinerResults(
-		self, 
-		stages: list[int]) -> dict[int, list[LinerResult]]:
+	def GetLinerResults(self, stages: list[int]) -> dict[int, list[LinerResult]]:
+		"""
+		:ref:`Support Liner Results Example`
+		
+		|  Returns a map of LinerResult for all input stages and support liner defined in your model.
 
+		"""
 		map_data = self._callFunction('GetLinerResults', [stages])
 		structured_data = {}
 		for stage_idx, stage_data in map_data.items():
 
 			structured_data[stage_idx] = []
 			for entity_name, entity_data in stage_data.items():
-				liner_result = self.process_liner_data(entity_data, entity_name)
+				liner_result = self._process_liner_data(entity_data, entity_name)
 				structured_data[stage_idx].append(liner_result)
 		
 		return structured_data
 
+	def GetPileResults(self, stages: list[int]) -> dict[int, list[PileResult]]:
+		"""
+		:ref:`Support Pile Results Example`
+		
+		|  Returns a map of PileResult for all input stages and support pile defined in your model.
 
-	def GetPileResults(	
-		self, 
-		stages: list[int]) -> dict[int, list[PileResult]]:
+		"""
 		return self._get_composition_result('GetPileResults',PileResult, stages)
 
-	def GetCompositeResults(	
-		self, 
-		stages: list[int]) -> dict[int, list[CompositeResult]]:
+	def GetCompositeResults(self, stages: list[int]) -> dict[int, list[CompositeResult]]:
+		"""
+		:ref:`Support Composite Results Example`
+		
+		|  Returns a map of CompositeResult for all input stages and support composite defined in your model.
+
+		"""
 		return self._get_composition_result('GetCompositeResults',CompositeResult, stages)
 
-	def GetStructuralResults(	
-		self, 
-		stages: list[int]) -> dict[int, list[PileResult]]:
-		return self._get_composition_result('GetStructuralResults',StructuralResult, stages)
+	def GetStructuralResults(self, stages: list[int]) -> dict[int, list[StructuralResult]]:
+		"""
+		:ref:`Support Structural Results Example`
+		
+		|  Returns a map of StructuralResult for all input stages and support structural defined in your model.
 
+		"""
+		return self._get_composition_result('GetStructuralResults',StructuralResult, stages)
 
 	def _get_composition_result(
 	self,
@@ -409,16 +337,19 @@ class ModelProxy(ProxyObject):
 		for stage_idx, stage_data in map_data.items():
 			structured_data[stage_idx] = []
 			for entity_name, entity_data in stage_data.items():
-				liner_result = self.process_liner_data(entity_data, entity_name)
-				joint_result = self.process_joint_data(entity_data, entity_name)
+				liner_result = self._process_liner_data(entity_data, entity_name)
+				joint_result = self._process_joint_data(entity_data, entity_name)
 				composition_result = ResultType(entity_name,joint_result,liner_result)
 				structured_data[stage_idx].append(composition_result)
 
 		return structured_data
 
-	def getUnits(self):
+	def getUnits(self) -> Units:
 		'''
-		Get Units
+		:ref:`Get Model Units Example`
+
+		|  Get Solid, Hydro and Thermal units for your model
+		
 		'''
 		NUM_UNITS = 3
 		data = self._callFunction('getUnits', [])
@@ -429,6 +360,6 @@ class ModelProxy(ProxyObject):
 
 	def getCriticalSRF(self):
 		'''
-		Get Critical SRF
+		|  Get Critical SRF
 		'''
 		return ResetInvalid.validate_double(self._callFunction('getCriticalSRF', []))

rs2/interpreter/JointResult.py

@@ -16,9 +16,9 @@ class JointElementResult:
         ResetInvalid.validate(self)
 
 class JointResult:
-    def __init__(self, entity_id, joint_element_results):
+    def __init__(self, entity_id, joint_element_results: JointElementResult):
         self.entity_id = entity_id
-        self.joint_element_results = joint_element_results
+        self.joint_element_results: JointElementResult = joint_element_results
 
 
 

rs2/interpreter/LinerResult.py

@@ -28,6 +28,6 @@ class LinerElementResult:
         ResetInvalid.validate(self)
 
 class LinerResult:
-    def __init__(self, entity_id, liner_element_results):
+    def __init__(self, entity_id, liner_element_results: LinerElementResult):
         self.entity_id = entity_id
-        self.liner_element_results = liner_element_results
+        self.liner_element_results: LinerElementResult = liner_element_results

rs2/interpreter/MeshResults.py

@@ -6,7 +6,7 @@ class MeshResults:
 
     def getXCoordinate(self, index):
         return self.results[index][0]
-    def getYCoordiante(self, index):
+    def getYCoordinate(self, index):
         return self.results[index][1]
     def getValue(self, index):
         return self.results[index][2]

rs2/interpreter/RS2Interpreter.py

@@ -1,7 +1,7 @@
 from rsmessages.requestFormat import functionRequest
 from rs2._common.Client import Client
 from rs2.utilities.ApplicationManager import ApplicationManager
-from rs2.interpreter.InterpreterModelProxy import ModelProxy
+from rs2.interpreter.InterpreterModel import Model
 import winreg
 import time
 
@@ -9,7 +9,7 @@ class RS2Interpreter:
 	def __init__(self, host = 'localhost', port=60055):
 		self.client = Client(host, port)
 
-	def openFile(self, fileName : str) -> ModelProxy:
+	def openFile(self, fileName : str) -> Model:
 		'''
 		Takes in the absolute path to an rs2 file to be opened in the modeler.
 
@@ -21,8 +21,8 @@ class RS2Interpreter:
 		'''
 		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
 		modelObjectId = self.client.callFunction(request)
-		modelProxy = ModelProxy(self.client, modelObjectId)
-		return modelProxy
+		model = Model(self.client, modelObjectId)
+		return model
 	
 	@classmethod
 	def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None:

rs2/modeler/{ModelProxy.py → Model.py}

@@ -8,12 +8,12 @@ from rs2.modeler.properties.pile.Pile import PileProperty
 from rs2.modeler.properties.StructuralInterface import StructuralInterfaceProperty
 from rs2.modeler.properties.CompositeProperty import CompositeProperty
 
-from rs2.modeler.properties.material.MaterialPropertyProxy import MaterialProperty
-from rs2.modeler.properties.ShearNormalFunctionProxy import ShearNormalFunction
+from rs2.modeler.properties.material.MaterialProperty import MaterialProperty
+from rs2.modeler.properties.ShearNormalFunction import ShearNormalFunction
 from rs2.modeler.properties.UserDefinedWaterMode import UserDefinedWaterMode
 from rs2.modeler.properties.DiscreteFunction import DiscreteFunction
 
-class ModelProxy(ProxyObject):
+class Model(ProxyObject):
 	"""
 	:ref:`Model Example`
 	"""
@@ -26,9 +26,8 @@ class ModelProxy(ProxyObject):
 		return DocumentProxy(self._client, documentObjectID)
     
 	def getBoltPropertyByName(self, boltName : str) -> BoltProperty:
-
 		'''
-		Returns a Bolt Property object based on its name.
+		|  Returns a Bolt Property object based on its name.
 		'''
 
 		boltObjectID = self._callFunction('getBoltPropertyByName', [boltName], keepReturnValueReference=True)
@@ -36,44 +35,42 @@ class ModelProxy(ProxyObject):
     
 	def getLinerPropertyByName(self, linerName : str) -> LinerProperty:
 		'''
-		Returns a Liner Property object based on its name.
+		|  Returns a Liner Property object based on its name.
 		'''
 		linerObjectID = self._callFunction('getLinerPropertyByName', [linerName], keepReturnValueReference=True)
 		return LinerProperty(self._client, linerObjectID, self._documentProxy._ID)
 	
 	def getJointPropertyByName(self, jointName : str) -> JointProperty:
 		'''
-		Returns a Joint Property object based on its name.
+		|  Returns a Joint Property object based on its name.
 		'''
 		jointObjectID = self._callFunction('getJointPropertyByName', [jointName], keepReturnValueReference=True)
 		return JointProperty(self._client, jointObjectID, self._documentProxy._ID)
 	
 	def getPilePropertyByName(self, pileName : str) -> PileProperty:
 		'''
-		Returns a Pile Property object based on its name.
+		|  Returns a Pile Property object based on its name.
 		'''
 		pileObjectID = self._callFunction('getPilePropertyByName', [pileName], keepReturnValueReference=True)
 		return PileProperty(self._client, pileObjectID, self._documentProxy._ID)
 
 	def getStructuralInterfacePropertyByName(self, structuralName : str) -> StructuralInterfaceProperty:
 		'''
-		Returns a Structural Interface Property object based on its name.
+		|  Returns a Structural Interface Property object based on its name.
 		'''
 		structuralInterfaceObjectID = self._callFunction('getStructuralPropertyByName', [structuralName], keepReturnValueReference=True)
 		return StructuralInterfaceProperty(self._client, structuralInterfaceObjectID, self._documentProxy._ID)
 	
 	def getCompositeLinerPropertyByName(self, compositeName : str) -> CompositeProperty:
 		'''
-		Returns a Composite Liner Property object based on its name.
+		|  Returns a Composite Liner Property object based on its name.
 		'''
 		compositeLinerObjectID = self._callFunction('getCompositePropertyByName', [compositeName], keepReturnValueReference=True)
 		return CompositeProperty(self._client, compositeLinerObjectID, self._documentProxy._ID)
-	
-	
 
 	def getMaterialPropertyByName(self, materialName : str) -> MaterialProperty:
 		'''
-		Returns a Material Property object based on its name.
+		|  Returns a Material Property object based on its name.
 		'''
 		materialObjectID = self._callFunction('getMaterialPropertyByName', [materialName], keepReturnValueReference=True)
 		return MaterialProperty(self._client, materialObjectID, self._documentProxy._ID)
@@ -81,7 +78,7 @@ class ModelProxy(ProxyObject):
 	def getAllBoltProperties(self) -> list[BoltProperty]:
 
 		'''
-		Returns a list of all Bolt Property objects
+		|  Returns a list of all Bolt Property objects
 		'''
 		activeBoltProperties = []
 		boltObjectIDList = self._callFunction('getAllBoltProperties', [], keepReturnValueReference=True)
@@ -91,7 +88,7 @@ class ModelProxy(ProxyObject):
 
 	def getAllLinerProperties(self) -> list[LinerProperty]:
 		'''
-		Returns a list of all Liner Property objects
+		|  Returns a list of all Liner Property objects
 		'''
 		activeLinerProperties = []
 		linerObjectIDList = self._callFunction('getAllLinerProperties', [], keepReturnValueReference=True)
@@ -101,7 +98,7 @@ class ModelProxy(ProxyObject):
 	
 	def getAllJointProperties(self) -> list[JointProperty]:
 		'''
-		Returns a list of all Joint Property objects
+		|  Returns a list of all Joint Property objects
 		'''
 		activeJointProperties = []
 		jointObjectIDList = self._callFunction('getAllJointProperties', [], keepReturnValueReference=True)
@@ -111,7 +108,7 @@ class ModelProxy(ProxyObject):
 	
 	def getAllPileProperties(self) -> list[PileProperty]:
 		'''
-		Returns a list of all Pile Property objects
+		|  Returns a list of all Pile Property objects
 		'''
 		activePileProperties = []
 		pileObjectIDList = self._callFunction('getAllPileProperties', [], keepReturnValueReference=True)
@@ -121,7 +118,7 @@ class ModelProxy(ProxyObject):
 	
 	def getAllStructuralInterfaceProperties(self) -> list[StructuralInterfaceProperty]:
 		'''
-		Returns a list of all Structural Interface Property objects
+		|  Returns a list of all Structural Interface Property objects
 		'''
 		activeStructuralProperties = []
 		structuralObjectIDList = self._callFunction('getAllStructuralProperties', [], keepReturnValueReference=True)
@@ -131,7 +128,7 @@ class ModelProxy(ProxyObject):
 	
 	def getAllCompositeLinerProperties(self) -> list[CompositeProperty]:
 		'''
-		Returns a list of all Composite Liner Property objects
+		|  Returns a list of all Composite Liner Property objects
 		'''
 		activeCompositeProperties = []
 		compositeObjectIDList = self._callFunction('getAllCompositeProperties', [], keepReturnValueReference=True)
@@ -141,7 +138,7 @@ class ModelProxy(ProxyObject):
 	
 	def getAllMaterialProperties(self) -> list[MaterialProperty]:
 		'''
-		Returns a list of all Material Property objects
+		|  Returns a list of all Material Property objects
 		'''
 		activeMaterialProperties = []
 		materialObjectIDList = self._callFunction('getAllMaterialProperties', [], keepReturnValueReference=True)
@@ -151,7 +148,7 @@ class ModelProxy(ProxyObject):
 	
 	def getShearNormalFunctions(self) -> list[ShearNormalFunction]:
 		'''
-		Returns a list of all shear normal functions
+		|  Returns a list of all shear normal functions
 		'''
 		activeShearNormalFunctionProperties = []
 		shearNormalFunctionIDList = self._callFunction('getShearNormalFunctions', [], keepReturnValueReference=True)
@@ -161,85 +158,78 @@ class ModelProxy(ProxyObject):
 	
 	def getShearNormalFunctionByName(self, shearNormalFunctionName : str) -> ShearNormalFunction:
 		'''
-		Returns a shear normal function object based on its name.
+		|  Returns a shear normal function object based on its name.
 		'''
 		shearNormalFunctionObjectID = self._callFunction('getShearNormalFunctionByName', [shearNormalFunctionName], keepReturnValueReference=True)
 		return ShearNormalFunction(self._client, shearNormalFunctionObjectID)
 	
 	def createNewShearNormalFunction(self, functionName):
 		'''
-		Creates a new shear normal function with the given name
+		|  Creates a new shear normal function with the given name
 		'''
 		return self._callFunction('createNewShearNormalFunction', [functionName])
 	
 	def deleteShearNormalFunction(self, functionName):
 		'''
-		Deletes a shear normal function with the given name
+		|  Deletes a shear normal function with the given name
 		'''
 		return self._callFunction('deleteShearNormalFunction', [functionName])
 	
 	def renameShearNormalFunction(self, oldName, newName):
 		'''
-		Renames a shear normal function with the given name
+		|  Renames a shear normal function with the given name
 		'''
 		return self._callFunction('renameShearNormalFunction', [oldName, newName])
 	
 	def getUserDefinedPermeabilityAndWaterContentMode(self, name : str) -> UserDefinedWaterMode:
 		'''
-		Returns a User Defined Water Mode object based on its name.
+		|  Returns a User Defined Water Mode object based on its name.
 		'''
 		userDefinedWaterModeObjectID = self._callFunction('getUserDefinedWaterMode', [name], keepReturnValueReference=True)
 		return UserDefinedWaterMode(self._client, userDefinedWaterModeObjectID)
 	
 	def createUserDefinedPermeabilityAndWaterContentMode(self, name : str) -> UserDefinedWaterMode:
 		'''
-		Creates a User Defined Water Mode object with the given name.
+		|  Creates a User Defined Water Mode object with the given name.
 		'''
 		userDefinedWaterModeObjectID = self._callFunction('createUserDefinedWaterMode', [name], keepReturnValueReference=True)
 		return UserDefinedWaterMode(self._client, userDefinedWaterModeObjectID)
 
 	def deleteUserDefinedPermeabilityAndWaterContentMode(self, name : str):
 		'''
-		Deletes a User Defined Water Mode object with the given name.
+		|  Deletes a User Defined Water Mode object with the given name.
 		'''
 		return self._callFunction('deleteUserDefinedWaterMode', [name])
 	
 	def renameUserDefinedPermeabilityAndWaterContentMode(self, oldName : str, newName : str):
 		'''
-		Renames a User Defined Water Mode object with the given name.
+		|  Renames a User Defined Water Mode object with the given name.
 		'''
 		return self._callFunction('renameUserDefinedWaterMode', [oldName, newName])
 	
 	def AddHistoryQueryPoint(self, x: float, y: float, history_query_name: str):
 		'''
-		Add a new History Query point to your model with the specified coordinates and label name
+		:ref:`History Query Example`
 
-		Args:
-			x (float): The x-coordinate value for the query point.
-			y (float): The y-coordinate value for the query point.
-			history_query_name (str): The label name for your query point.
+		|  Add a new History Query point to your model with the specified coordinates and label name
 
 		'''
 		return self._callFunction('AddHistoryQueryPoint', [x, y, history_query_name])
-	
 
 	def RemoveHistoryQueryPoint(self, history_query_name: str):
 		'''
-		Remove a History Query point from your model by label name.
+		:ref:`History Query Example`
 
-		Args:
-			history_query_name (str): The label name for your query point.
+		|  Remove a History Query point from your model by label name.
 
 		'''
 		return self._callFunction('RemoveHistoryQueryPoint', [history_query_name])
 
 	def AddTimeQueryLine(self, points: list[list[float]], points_on_line: int) -> str:
 		'''
-		Add a new Time Query Line to your model with the specified coordinates
+		:ref:`Time Query Example`
 
-		Args:
-			points (list[list[float]]) : List of points making the time query line.
-			points_on_line (int) : Number of segments to evenly divide time query line
+		|  Add a new Time Query Line to your model with the specified coordinates
 		
 		Warning:
 			points_on_line must be between 1 and 10 inclusive.
@@ -249,38 +239,34 @@ class ModelProxy(ProxyObject):
 	
 	def RemoveTimeQueryLine(self, IDs_toRemove: list[str]):
 		'''
-		Removes Time Query Line(s) from your model using provided list of IDs.
+		:ref:`Time Query Example`
 
-		Args:
-			IDs_toRemove (list[str]): List of unique identifier for time query line(s) to remove.
+		|  Removes Time Query Line(s) from your model using provided list of IDs.
 
 		'''
 		return self._callFunction('RemoveTimeQueryLine', [IDs_toRemove])
 	
 	def AddTimeQueryPoint(self, x: float, y: float) -> str:
 		'''
-		Add a new Time Query Point to your model with the specified x and y coordinates
+		:ref:`Time Query Example`
 
-		Args:
-			x (float) : x-coordinate of the time query line.
-			y (float) : y-coordinate of the time query line.
+		|  Add a new Time Query Point to your model with the specified x and y coordinates
 
 		'''
 		return self._callFunction('AddTimeQueryPoint', [x, y])
 	
 	def RemoveTimeQueryPoint(self, IDs_toRemove: list[str]):
 		'''
-		Removes Time Query Point(s) from your model using provided list of IDs.
-
-		Args:
-			IDs_toRemove (list[str]): List of unique identifier for time query points(s) to remove.
+		:ref:`Time Query Example`
+		
+		|  Removes Time Query Point(s) from your model using provided list of IDs.
 
 		'''
 		return self._callFunction('RemoveTimeQueryPoint', [IDs_toRemove])
 	
 	def compute(self):
 		'''
-		Saves the file if modified and then runs compute. Replaces any existing results.
+		|  Saves the file if modified and then runs compute. Replaces any existing results.
 
 		Warning:
 			All objects retrieved from the interpreter for this file will be invalidated after this call.
@@ -297,7 +283,7 @@ class ModelProxy(ProxyObject):
 
 	def computeGroundWater(self):
 		'''
-		Saves the file if modified and then runs groundwater compute. Replaces any existing results.
+		|  Saves the file if modified and then runs groundwater compute. Replaces any existing results.
 
 		Warning:
 			All objects retrieved from the interpreter for this file will be invalidated after this call.
@@ -313,13 +299,15 @@ class ModelProxy(ProxyObject):
 
 	def close(self):
 		'''
-		Closes the model
+		:ref:`Model Example`
+
+		|  Closes the model
 		'''
 		return self._callFunction('close', [])
 
 	def saveAs(self, fileName : str):
 		'''
-		Saves the model using the given file name.
+		|  Saves the model using the given file name.
 
 		Example:
 
@@ -332,13 +320,15 @@ class ModelProxy(ProxyObject):
 
 	def save(self):
 		'''
-		Saves the model
+		:ref:`Model Example`
+
+		|  Saves the model
 		'''
 		return self._callFunction('save', [])
 
 	def getDiscreteFunctions(self) -> list[DiscreteFunction]:
 		'''
-		Returns a list of all discrete functions
+		|  Returns a list of all discrete functions
 		'''
 		activeDiscreteFunctionProperties = []
 		discreteFunctionIDList = self._callFunction('getDiscreteFunctions', [], keepReturnValueReference=True)
@@ -348,31 +338,34 @@ class ModelProxy(ProxyObject):
 	
 	def getDiscreteFunctionByName(self, discreteFunctionName : str) -> DiscreteFunction:
 		'''
-		Returns a discrete function object based on its name.
+		|  Returns a discrete function object based on its name.
 		'''
 		discreteFunctionObjectID = self._callFunction('getDiscreteFunctionByName', [discreteFunctionName], keepReturnValueReference=True)
 		return DiscreteFunction(self._client, discreteFunctionObjectID)
 	
 	def createNewDiscreteFunction(self, functionName):
 		'''
-		Creates a new discrete function with the given name
+		|  Creates a new discrete function with the given name
 		'''
 		return self._callFunction('createNewDiscreteFunction', [functionName])
 	
 	def deleteDiscreteFunction(self, functionName):
 		'''
-		Deletes a discrete function with the given name
+		|  Deletes a discrete function with the given name
 		'''
 		return self._callFunction('deleteDiscreteFunction', [functionName])
 	
 	def renameDiscreteFunction(self, oldName, newName):
 		'''
-		Renames a discrete function with the given name
+		|  Renames a discrete function with the given name
 		'''
 		return self._callFunction('renameDiscreteFunction', [oldName, newName])	
+	
 	def getUnits(self):
 		'''
-		Get Units
+		:ref:`Get Model Units Example`
+
+		|  Get Solid, Hydro and Thermal units for your model
 		'''
 		NUM_UNITS = 3
 		data = self._callFunction('getUnits', [])
@@ -383,7 +376,10 @@ class ModelProxy(ProxyObject):
 
 	def ResetProperties(self):
 		'''
-		Reset All Properties
+		:ref:`Get Model Units Example`
+
+		|  Reset all properties for your model
+
 		'''
 		return self._callFunction('ResetProperties', [])
 	

rs2/modeler/RS2Modeler.py

@@ -1,6 +1,6 @@
 from rsmessages.requestFormat import functionRequest
 from rs2._common.Client import Client
-from rs2.modeler.ModelProxy import ModelProxy
+from rs2.modeler.Model import Model
 from rs2.utilities.ApplicationManager import ApplicationManager
 import winreg
 import time
@@ -12,7 +12,7 @@ class RS2Modeler:
 	def __init__(self, host='localhost', port=60054):
 		self.client = Client(host, port)
 
-	def openFile(self, fileName : str) -> ModelProxy:
+	def openFile(self, fileName : str) -> Model:
 		'''
 		Takes in the absolute path to an rs2 file to be opened in the modeler.
 
@@ -24,8 +24,8 @@ class RS2Modeler:
 		'''
 		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
 		modelObjectId = self.client.callFunction(request)
-		modelProxy = ModelProxy(self.client, modelObjectId)
-		return modelProxy
+		model = Model(self.client, modelObjectId)
+		return model
 
 	@classmethod
 	def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None:

rs2/modeler/properties/material/hydraulic/Hydraulic.py

@@ -20,7 +20,7 @@ class HydraulicDefinedStageFactor(HydraulicStageFactor):
 		return self._callFunction("setMaterialBehaviourFactor", [materialBehavior.value])
 class Hydraulic(PropertyProxy):
 	"""
-	:ref:`Hydraulic Property Stiffness Example`
+	:ref:`Hydraulic Property Example`
 	"""
 	def __init__(self, client : Client, ID, documentProxyID, stageFactorInterfaceID):
 		super().__init__(client, ID, documentProxyID)

rs2/modeler/properties/material/hydraulic/StaticGroundwater.py

@@ -21,6 +21,9 @@ class StaticGroundwaterDefinedStageFactor(StaticGroundwaterStageFactor):
 	def setGridToUse(self, gridName: str):
 		return self._callFunction("setGridToUse", [gridName, self.propertyID], proxyArgumentIndices=[1])
 class StaticGroundwater(PropertyProxy):
+	"""
+	:ref:`Hydraulic Property Static Groundwater Example`
+	"""
 	def __init__(self, client : Client, ID, documentProxyID, stageFactorInterfaceID):
 		super().__init__(client, ID, documentProxyID)
 		self.stageFactorInterface = AbsoluteStageFactorGettersInterface[StaticGroundwaterDefinedStageFactor, StaticGroundwaterStageFactor](self._client, stageFactorInterfaceID, ID, StaticGroundwaterDefinedStageFactor, StaticGroundwaterStageFactor)

rs2/modeler/properties/material/thermal/conductivity/Conductivity.py

@@ -11,7 +11,7 @@ from rs2.modeler.properties.material.thermal.conductivity.CoteAndKonrad import C
 from rs2.modeler.properties.material.thermal.conductivity.Tabular import Tabular
 class Conductivity(PropertyProxy):
 	"""
-	:ref:`Material Property Thermal Conductivity Example`
+	:ref:`Material Property Thermal Example`
 	"""
 	def __init__(self, client : Client, ID, documentProxyID):
 		self.ConstantConductivity = ConstantConductivity(client, ID, documentProxyID)

rs2/modeler/properties/material/thermal/heatcapacity/HeatCapacity.py

@@ -8,7 +8,7 @@ from rs2.modeler.properties.material.thermal.heatcapacity.JameNewman import Jame
 from rs2.modeler.properties.material.thermal.heatcapacity.CustomHeatCapacity import CustomHeatCapacity
 class HeatCapacity(PropertyProxy):
 	"""
-	:ref:`Material Property Thermal HeatCapacity Example`
+	:ref:`Material Property Thermal Example`
 	"""
 	def __init__(self, client : Client, ID, documentProxyID):
 		self.ConstantHeatCapacity = ConstantHeatCapacity(client, ID, documentProxyID)

rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/SoilUnfrozenWaterContent.py

@@ -9,7 +9,7 @@ from rs2.modeler.properties.material.thermal.soilunfrozenwatercontent.CustomWate
 from rs2.modeler.properties.material.thermal.soilunfrozenwatercontent.hydraulic.HydraulicModel import HydraulicModel
 class SoilUnfrozenWaterContent(PropertyProxy):
 	"""
-	:ref:`Material Property Thermal SoilUnfrozenWaterContent Example`
+	:ref:`Material Property Thermal Example`
 	"""
 	def __init__(self, client : Client, ID, documentProxyID):
 		self.Konrad = Konrad(client, ID, documentProxyID)

rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/HydraulicModel.py

@@ -10,7 +10,7 @@ from rs2.modeler.properties.material.thermal.soilunfrozenwatercontent.hydraulic.
 from rs2.modeler.properties.material.thermal.soilunfrozenwatercontent.hydraulic.GardnerWaterContent import GardnerWaterContent
 class HydraulicModel(PropertyProxy):
 	"""
-	:ref:`Material Property Thermal SoilUnfrozenWaterContent HydraulicModel Example`
+	:ref:`Material Property Thermal Example`
 	"""
 	def __init__(self, client : Client, ID, documentProxyID):
 		self.SimpleWaterContent = SimpleWaterContent(client, ID, documentProxyID)