RS2Scripting 11.23.0.dev1__tar.gz → 11.23.0.dev2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. {RS2Scripting-11.23.0.dev1/src/RS2Scripting.egg-info → RS2Scripting-11.23.0.dev2}/PKG-INFO +1 -1
  2. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/pyproject.toml +1 -1
  3. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2/src/RS2Scripting.egg-info}/PKG-INFO +1 -1
  4. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/RS2Scripting.egg-info/SOURCES.txt +4 -4
  5. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/BoltResult.py +3 -3
  6. RS2Scripting-11.23.0.dev2/src/rs2/interpreter/CompositeResult.py +24 -0
  7. RS2Scripting-11.23.0.dev1/src/rs2/interpreter/InterpreterModelProxy.py → RS2Scripting-11.23.0.dev2/src/rs2/interpreter/InterpreterModel.py +88 -158
  8. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/JointResult.py +2 -2
  9. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/LinerResult.py +2 -2
  10. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/MeshResults.py +1 -1
  11. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/RS2Interpreter.py +4 -4
  12. RS2Scripting-11.23.0.dev1/src/rs2/modeler/ModelProxy.py → RS2Scripting-11.23.0.dev2/src/rs2/modeler/Model.py +61 -65
  13. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/RS2Modeler.py +4 -4
  14. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/Hydraulic.py +1 -1
  15. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/StaticGroundwater.py +3 -0
  16. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/Conductivity.py +1 -1
  17. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/heatcapacity/HeatCapacity.py +1 -1
  18. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/SoilUnfrozenWaterContent.py +1 -1
  19. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/HydraulicModel.py +1 -1
  20. RS2Scripting-11.23.0.dev1/src/rs2/interpreter/CompositeResult.py +0 -23
  21. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/License.txt +0 -0
  22. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/README.md +0 -0
  23. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/setup.cfg +0 -0
  24. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/RS2Scripting.egg-info/dependency_links.txt +0 -0
  25. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/RS2Scripting.egg-info/requires.txt +0 -0
  26. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/RS2Scripting.egg-info/top_level.txt +0 -0
  27. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/__init__.py +0 -0
  28. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/_common/Client.py +0 -0
  29. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/_common/ProxyObject.py +0 -0
  30. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/_common/Units.py +0 -0
  31. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/_common/__init__.py +0 -0
  32. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/_common/documentProxy.py +0 -0
  33. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/HistoryQueryResults.py +0 -0
  34. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/InterpreterEnums.py +0 -0
  35. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/InterpreterGraphEnums.py +0 -0
  36. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/MaterialQueryResults.py +0 -0
  37. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/TimeQueryResults.py +0 -0
  38. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/UtilityResult.py +0 -0
  39. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/interpreter/__init__.py +0 -0
  40. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/__init__.py +0 -0
  41. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/AbsoluteStageFactorGettersInterface.py +0 -0
  42. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/AbsoluteStageFactorInterface.py +0 -0
  43. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/CompositeProperty.py +0 -0
  44. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/DiscreteFunction.py +0 -0
  45. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/MaterialJoint.py +0 -0
  46. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/MaterialJointOptions.py +0 -0
  47. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/PropertyEnums.py +0 -0
  48. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/RelativeStageFactorInterface.py +0 -0
  49. /RS2Scripting-11.23.0.dev1/src/rs2/modeler/properties/ShearNormalFunctionProxy.py → /RS2Scripting-11.23.0.dev2/src/rs2/modeler/properties/ShearNormalFunction.py +0 -0
  50. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/SnowdenAnisotropicFunction.py +0 -0
  51. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/StructuralInterface.py +0 -0
  52. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/UserDefinedWaterMode.py +0 -0
  53. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/__init__.py +0 -0
  54. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/Bolt.py +0 -0
  55. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/EndAnchored.py +0 -0
  56. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/FullyBonded.py +0 -0
  57. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/PlainStrandCable.py +0 -0
  58. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/Swellex.py +0 -0
  59. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/Tieback.py +0 -0
  60. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/bolt/__init__.py +0 -0
  61. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/BartonBandis.py +0 -0
  62. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/BartonBandisMaterial.py +0 -0
  63. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/DisplacementDependent.py +0 -0
  64. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/GeosyntheticHyperbolic.py +0 -0
  65. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/GeosyntheticHyperbolicMaterial.py +0 -0
  66. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/HyperbolicSoftening.py +0 -0
  67. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/Joint.py +0 -0
  68. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/MaterialDependent.py +0 -0
  69. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/MohrCoulomb.py +0 -0
  70. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/MohrCoulombMaterial.py +0 -0
  71. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/NoneSlip.py +0 -0
  72. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/joint/__init__.py +0 -0
  73. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/liner/CableTruss.py +0 -0
  74. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/liner/Geosynthetic.py +0 -0
  75. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/liner/Liner.py +0 -0
  76. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/liner/ReinforcedConcrete.py +0 -0
  77. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/liner/StandardBeam.py +0 -0
  78. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/liner/__init__.py +0 -0
  79. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/InitialConditions.py +0 -0
  80. /RS2Scripting-11.23.0.dev1/src/rs2/modeler/properties/material/MaterialPropertyProxy.py → /RS2Scripting-11.23.0.dev2/src/rs2/modeler/properties/material/MaterialProperty.py +0 -0
  81. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/StageFactors.py +0 -0
  82. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/__init__.py +0 -0
  83. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/datum/BaseDatum.py +0 -0
  84. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/datum/Datum.py +0 -0
  85. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/datum/PeakResidualDatum.py +0 -0
  86. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/datum/SimpleDatum.py +0 -0
  87. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/datum/__init__.py +0 -0
  88. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Brooks.py +0 -0
  89. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Constant.py +0 -0
  90. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/FEAGroundwater.py +0 -0
  91. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Fredlund.py +0 -0
  92. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Gardner.py +0 -0
  93. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Genuchten.py +0 -0
  94. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Simple.py +0 -0
  95. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/UserDefined.py +0 -0
  96. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/__init__.py +0 -0
  97. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/hydraulic/__init__.py +0 -0
  98. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/ChSoil.py +0 -0
  99. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Custom.py +0 -0
  100. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/CySoil.py +0 -0
  101. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/DoubleYield.py +0 -0
  102. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/HardeningSoil.py +0 -0
  103. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/HardeningSoilSmallStrainStiffness.py +0 -0
  104. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Isotropic.py +0 -0
  105. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/ManzariAndDafalias.py +0 -0
  106. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/NonLinearHyperbolic.py +0 -0
  107. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/NonLinearIsotropic.py +0 -0
  108. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Norsand.py +0 -0
  109. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Orthotropic.py +0 -0
  110. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Pm4Sand.py +0 -0
  111. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Pm4Silt.py +0 -0
  112. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/SoftSoil.py +0 -0
  113. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/SoftSoilCreep.py +0 -0
  114. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/Stiffness.py +0 -0
  115. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/SwellingRock.py +0 -0
  116. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/TransverselyIsotropic.py +0 -0
  117. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/ViscoElastic.py +0 -0
  118. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/stiffness/__init__.py +0 -0
  119. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/AnisotropicLinear.py +0 -0
  120. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/BarcelonaBasic.py +0 -0
  121. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/BartonBandisStrength.py +0 -0
  122. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/BoundingSurfacePlasticity.py +0 -0
  123. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/CamClay.py +0 -0
  124. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/ChSoilStrength.py +0 -0
  125. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/CySoilStrength.py +0 -0
  126. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/DiscreteFunction.py +0 -0
  127. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/DoubleYieldStrength.py +0 -0
  128. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/DruckerPrager.py +0 -0
  129. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/Finn.py +0 -0
  130. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/GeneralizedAnisotropic.py +0 -0
  131. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/GeneralizedHoekBrown.py +0 -0
  132. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/HardeningSoilStrength.py +0 -0
  133. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/HardeningSoilWithSmallStrainStiffness.py +0 -0
  134. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/HoekBrown.py +0 -0
  135. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/Hyperbolic.py +0 -0
  136. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/JointedGeneralizedHoekBrown.py +0 -0
  137. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/JointedMohrCoulomb.py +0 -0
  138. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/ManzariAndDafaliasStrength.py +0 -0
  139. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/ModifiedCamClay.py +0 -0
  140. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/MohrCoulombStrength.py +0 -0
  141. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/MohrCoulombWithCap.py +0 -0
  142. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/NorSandStrength.py +0 -0
  143. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/PM4SandStrength.py +0 -0
  144. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/PM4SiltStrength.py +0 -0
  145. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/PowerCurve.py +0 -0
  146. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/Shansep.py +0 -0
  147. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/ShearNormalFunction.py +0 -0
  148. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/SnowdenModAnisotropicLinear.py +0 -0
  149. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/SoftSoilCreepStrength.py +0 -0
  150. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/SoftSoilStrength.py +0 -0
  151. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/SofteningHardeningModel.py +0 -0
  152. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/Strength.py +0 -0
  153. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/SwellingRockStrength.py +0 -0
  154. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/VerticalStressRatio.py +0 -0
  155. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/strength/__init__.py +0 -0
  156. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/Thermal.py +0 -0
  157. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/__init__.py +0 -0
  158. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/ConstantConductivity.py +0 -0
  159. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/CoteAndKonrad.py +0 -0
  160. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/Derives.py +0 -0
  161. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/Johansen.py +0 -0
  162. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/JohansenLu.py +0 -0
  163. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/Tabular.py +0 -0
  164. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/conductivity/__init__.py +0 -0
  165. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/heatcapacity/ConstantHeatCapacity.py +0 -0
  166. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/heatcapacity/CustomHeatCapacity.py +0 -0
  167. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/heatcapacity/JameNewman.py +0 -0
  168. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/heatcapacity/__init__.py +0 -0
  169. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/CustomWaterContent.py +0 -0
  170. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/Konrad.py +0 -0
  171. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/TiceAnderson.py +0 -0
  172. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/__init__.py +0 -0
  173. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/BrooksWaterContent.py +0 -0
  174. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/FredlundWaterContent.py +0 -0
  175. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/GardnerWaterContent.py +0 -0
  176. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/GenuchtenWaterContent.py +0 -0
  177. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/SimpleWaterContent.py +0 -0
  178. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/material/thermal/soilunfrozenwatercontent/hydraulic/__init__.py +0 -0
  179. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/Beam.py +0 -0
  180. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/Elastic.py +0 -0
  181. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/ForceDisplacement.py +0 -0
  182. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/Linear.py +0 -0
  183. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/MaterialDependentPile.py +0 -0
  184. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/MohrCoulombPile.py +0 -0
  185. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/MultiLinear.py +0 -0
  186. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/Pile.py +0 -0
  187. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/pile/__init__.py +0 -0
  188. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/modeler/properties/propertyProxy.py +0 -0
  189. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/utilities/ApplicationManager.py +0 -0
  190. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/utilities/ColorPicker.py +0 -0
  191. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/src/rs2/utilities/__init__.py +0 -0
  192. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testExampleCode.py +0 -0
  193. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testFileOpenWarning.py +0 -0
  194. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testInterpreterMultipleFileCloseProgram.py +0 -0
  195. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testInterpreterSaveAs.py +0 -0
  196. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testInterpreterSingleFileCloseProgram.py +0 -0
  197. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testMaterialJointOptions.py +0 -0
  198. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testModelerMultipleFileCloseProgram.py +0 -0
  199. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testModelerSingleFileCloseProgram.py +0 -0
  200. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testOpenFileNoResults.py +0 -0
  201. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testShearNormalFunction.py +0 -0
  202. {RS2Scripting-11.23.0.dev1 → RS2Scripting-11.23.0.dev2}/tests/testSnowdenAnisotropicFunction.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: RS2Scripting
3
- Version: 11.23.0.dev1
3
+ Version: 11.23.0.dev2
4
4
  Summary: Client library for interacting with RS2 through python
5
5
  Author: Rocscience
6
6
  License: MIT License
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "RS2Scripting"
7
- version = "11.23.0.dev1"
7
+ version = "11.23.0.dev2"
8
8
  dependencies = [
9
9
  "rsmessages == 0.0.2.dev1"
10
10
  ]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: RS2Scripting
3
- Version: 11.23.0.dev1
3
+ Version: 11.23.0.dev2
4
4
  Summary: Client library for interacting with RS2 through python
5
5
  Author: Rocscience
6
6
  License: MIT License
@@ -17,7 +17,7 @@ src/rs2/interpreter/CompositeResult.py
17
17
  src/rs2/interpreter/HistoryQueryResults.py
18
18
  src/rs2/interpreter/InterpreterEnums.py
19
19
  src/rs2/interpreter/InterpreterGraphEnums.py
20
- src/rs2/interpreter/InterpreterModelProxy.py
20
+ src/rs2/interpreter/InterpreterModel.py
21
21
  src/rs2/interpreter/JointResult.py
22
22
  src/rs2/interpreter/LinerResult.py
23
23
  src/rs2/interpreter/MaterialQueryResults.py
@@ -26,7 +26,7 @@ src/rs2/interpreter/RS2Interpreter.py
26
26
  src/rs2/interpreter/TimeQueryResults.py
27
27
  src/rs2/interpreter/UtilityResult.py
28
28
  src/rs2/interpreter/__init__.py
29
- src/rs2/modeler/ModelProxy.py
29
+ src/rs2/modeler/Model.py
30
30
  src/rs2/modeler/RS2Modeler.py
31
31
  src/rs2/modeler/__init__.py
32
32
  src/rs2/modeler/properties/AbsoluteStageFactorGettersInterface.py
@@ -37,7 +37,7 @@ src/rs2/modeler/properties/MaterialJoint.py
37
37
  src/rs2/modeler/properties/MaterialJointOptions.py
38
38
  src/rs2/modeler/properties/PropertyEnums.py
39
39
  src/rs2/modeler/properties/RelativeStageFactorInterface.py
40
- src/rs2/modeler/properties/ShearNormalFunctionProxy.py
40
+ src/rs2/modeler/properties/ShearNormalFunction.py
41
41
  src/rs2/modeler/properties/SnowdenAnisotropicFunction.py
42
42
  src/rs2/modeler/properties/StructuralInterface.py
43
43
  src/rs2/modeler/properties/UserDefinedWaterMode.py
@@ -69,7 +69,7 @@ src/rs2/modeler/properties/liner/ReinforcedConcrete.py
69
69
  src/rs2/modeler/properties/liner/StandardBeam.py
70
70
  src/rs2/modeler/properties/liner/__init__.py
71
71
  src/rs2/modeler/properties/material/InitialConditions.py
72
- src/rs2/modeler/properties/material/MaterialPropertyProxy.py
72
+ src/rs2/modeler/properties/material/MaterialProperty.py
73
73
  src/rs2/modeler/properties/material/StageFactors.py
74
74
  src/rs2/modeler/properties/material/__init__.py
75
75
  src/rs2/modeler/properties/material/datum/BaseDatum.py
@@ -32,7 +32,7 @@ class BoltForceDisplacementResult:
32
32
  ResetInvalid.validate(self)
33
33
 
34
34
  class BoltResult:
35
- def __init__(self, entity_id, entity_data, yielding_results, force_displacement_results):
35
+ def __init__(self, entity_id, entity_data, yielding_results: BoltYieldingResult, force_displacement_results: BoltForceDisplacementResult):
36
36
  if len(entity_data) == 0 or len(entity_data[0]) == 0:
37
37
  assert False, 'location not defined'
38
38
  return
@@ -44,6 +44,6 @@ class BoltResult:
44
44
  self.start_y = start_y
45
45
  self.end_x = end_x
46
46
  self.end_y = end_y
47
- self.yielding_results = yielding_results
48
- self.force_displacement_results = force_displacement_results
47
+ self.yielding_results: BoltYieldingResult = yielding_results
48
+ self.force_displacement_results: BoltForceDisplacementResult = force_displacement_results
49
49
 
@@ -0,0 +1,24 @@
1
+ from rs2.interpreter.LinerResult import LinerResult
2
+ from rs2.interpreter.JointResult import JointResult
3
+
4
+ class PileResult:
5
+ def __init__(self, entity_id, joint_result: JointResult, liner_result: LinerResult):
6
+ self.entity_id = entity_id
7
+ self.joint_result: JointResult = joint_result
8
+ self.liner_result: LinerResult = liner_result
9
+
10
+ class CompositeResult:
11
+ def __init__(self, entity_id, joint_result: JointResult, liner_result: LinerResult):
12
+ self.entity_id = entity_id
13
+ self.joint_result: JointResult = joint_result
14
+ self.liner_result: LinerResult = liner_result
15
+
16
+ class StructuralResult:
17
+ def __init__(self, entity_id, joint_result: JointResult, liner_result: LinerResult):
18
+ self.entity_id = entity_id
19
+ self.joint_result: JointResult = joint_result
20
+ self.liner_result: LinerResult = liner_result
21
+
22
+
23
+
24
+
@@ -11,7 +11,7 @@ from rs2.interpreter.LinerResult import *
11
11
  from rs2.interpreter.BoltResult import*
12
12
  from rs2.interpreter.CompositeResult import*
13
13
  from rs2.interpreter.MaterialQueryResults import *
14
- class ModelProxy(ProxyObject):
14
+ class Model(ProxyObject):
15
15
  """
16
16
  :ref:`Model Example`
17
17
  """
@@ -25,7 +25,10 @@ class ModelProxy(ProxyObject):
25
25
 
26
26
  def close(self):
27
27
  '''
28
- Closes the model
28
+ :ref:`Model Example`
29
+
30
+ | Closes the model
31
+
29
32
  '''
30
33
  return self._callFunction('close', [])
31
34
 
@@ -44,23 +47,26 @@ class ModelProxy(ProxyObject):
44
47
 
45
48
  def save(self):
46
49
  '''
47
- Saves the model
50
+ :ref:`Model Example`
51
+
52
+ | Saves the model
53
+
48
54
  '''
49
55
  return self._callFunction('save', [])
50
56
 
51
57
  def SetActiveStage(self, stageNumber: int):
52
58
  '''
53
- Change model's active stage by its stage number
59
+ :ref:`Material Query Example`
60
+
61
+ | Change model's active stage by its stage number
54
62
  '''
55
63
  return self._callFunction('SetActiveStage', [stageNumber])
56
64
 
57
65
  def SetResultType(self, resultType: ExportResultType) -> list[dict]:
58
66
  """
59
- Sets the export result type for the model.
67
+ :ref:`Get Mesh Results Example`
60
68
 
61
- Args:
62
- resultType (ExportResultType): Takes an enum of type ExportResultType representing the desired
63
- export option for mesh results.
69
+ | Sets the export result type for your model.
64
70
 
65
71
  Raises:
66
72
  ValueError: resultType must be an enum of type ExportResultType. Any other value will raise an error
@@ -70,33 +76,16 @@ class ModelProxy(ProxyObject):
70
76
 
71
77
  def SetUserDefinedResultType(self, resultName: str) -> list[dict]:
72
78
  """
73
- Sets the export result type to the user defined result type name.
74
-
75
- Args:
76
- resultName (str): Takes the name of the user defined export option to generate mesh results for.
79
+ | Sets the export result type to the user defined result type name.
77
80
 
78
81
  """
79
82
  return self._callFunction('SetUserDefinedResultType', [resultName])
80
83
 
81
84
  def GetMeshResults(self) -> MeshResults:
82
85
  """
83
- Returns the mesh results at all nodes of the model.
84
-
85
- Returns:
86
- | An object of type MeshResults. To extract the x-coordinate, y-coordinate or value from the returned data,
87
- | please call the supported functions from the class:
88
- | MeshResults.GetXCoordinate(index)
89
- | MeshResults.GetYCoordinate(index)
90
- | MeshResults.GetValue(index)
91
-
92
- Example:
93
-
94
- .. code-block:: python
86
+ :ref:`Get Mesh Results Example`
95
87
 
96
- results = model.GetMeshResults()
97
- x_coordiante = results.GetXCoordinate(0)
98
- y_coordinate = results.GetYCoordinate(0)
99
- value = results.GetValue(0)
88
+ | Returns the mesh results at all nodes for your model.
100
89
 
101
90
  """
102
91
  results = self._callFunction('GetMeshResults', [])
@@ -105,38 +94,14 @@ class ModelProxy(ProxyObject):
105
94
  def GetHistoryQueryResults(self, hq_name: str, horizontal_axis: HistoryQueryGraphEnums.HorizontalAxisTypes, vertical_axis: HistoryQueryGraphEnums.VerticalAxisTypes,
106
95
  stages: list[int]) -> dict[int, list[HistoryQueryResult]]:
107
96
  """
108
- Returns the history query result for the provided query name with specified graph options and stages.
97
+ :ref:`History Query Example`
109
98
 
110
- Args:
111
- hq_name (str): Takes the name of the History Query Point.
112
- horizontal_axis (HistoryQueryGraphEnums): Takes the horizontal axis to generate results for.
113
- vertical_axis (HistoryQueryGraphEnums): Takes the vertical axis to generate results for.
114
- stages (int): Takes the stages by their stage number for which results should be returned.
115
-
116
- Returns:
117
- | Returns a dictionary with key as stage number and value a List of HistoryQueryResult object.
118
- | To extract the stage number, x-coordinate, y-coordinate, horizontal axis result and vertical axis result,
119
- | please call the supported functions from the class:
120
-
121
- * GetXCoordinate()
122
- * GetYCoordinate()
123
- * GetHorizontalAxisResult()
124
- * GetVerticalAxisResult()
125
-
126
- Example:
127
-
128
- .. code-block:: python
129
-
130
- results = model.GetHistoryQueryResults(params)
131
- results_for_stage_1 = results[1]
132
- x_coordiante = results_for_stage_1[0].GetXCoordinate()
133
- y_coordinate = results_for_stage_1[0].GetYCoordinate()
134
- horizontal_result = results_for_stage_1[0].GetHorizontalResult()
135
- vertical_result = results_for_stage_1[0].GetVerticalResult()
99
+ | Returns a map of HistoryQueryResult for all input stages and history queries in your model.
136
100
 
137
101
  Raises:
138
102
  ValueError: horizontal_axis and vertical_axis must be an enum of type HistoryQueryGraphEnums.
139
103
  Any other value will raise an error.
104
+
140
105
  """
141
106
  map_data = self._callFunction('GetHistoryQueryResults', [hq_name, horizontal_axis.value, vertical_axis.value, stages])
142
107
  structured_data = {}
@@ -153,35 +118,15 @@ class ModelProxy(ProxyObject):
153
118
  vertical_axis: TimeQueryGraphEnums.VerticalAxisTypes
154
119
  ) -> dict[int, list[TimeQueryPointResults]]:
155
120
  """
156
- Returns the results for all the time query points defined in the model for given stages and graph axes type.
157
-
158
- Please note points that are over an excavation at specific stages will not have data returned at those locations.
121
+ :ref:`Time Query Example`
159
122
 
160
- Args:
161
- stages (list[int]): Takes the stages by their stage number for which results should be returned.
162
- vertical_axis (TimeQueryGraphEnums): Takes the vertical axis to generate results for.
163
-
164
- Returns:
165
- | Returns a dictionary with key as stage number and value a list[TimeQueryPointResults] object.
166
- | To extract the unique identifier, x-coordinate, y-coordinate, horizontal axis result and vertical axis result,
167
- | please call the supported functions from the class:
168
-
169
- * TimeQueryPointResults.GetUniqueIdentifier()
170
-
171
- To get all the results for this query, please call:
123
+ | Returns a map of TimeQueryPointResults for all input stages and time query points in your model.
172
124
 
173
- * TimeQueryPointResults.GetAllValues()
174
-
175
- The above method returns list[QueryPointResult] for each node.
176
- To get the x-coordiante, y-coordinate, dynamic stage time or value, please call:
177
-
178
- * QueryPointResult.GetXCoordinate()
179
- * QueryPointResult.GetYCoordinate()
180
- * QueryPointResult.GetStageTime()
181
- * QueryPointResult.GetValue()
125
+ | Please note points that are over an excavation at specific stages will not have data returned at those locations.
182
126
 
183
127
  Raises:
184
128
  ValueError: vertical_axis must be an enum of type TimeQueryGraphEnums. Any other value will raise an error.
129
+
185
130
  """
186
131
  map_data = self._callFunction('GetAllTimeQueryPointsResults',
187
132
  [stages, vertical_axis.value])
@@ -202,37 +147,15 @@ class ModelProxy(ProxyObject):
202
147
  apply_post_process_scaling: bool
203
148
  ) -> dict[int, list[TimeQueryLineResults]]:
204
149
  """
205
- Returns the results for all the time query lines defined in the model for given stages and graph axes types.
150
+ :ref:`Time Query Example`
206
151
 
207
- Please note points that are over an excavation at specific stages will not have data returned at those locations.
152
+ | Returns a map of TimeQueryLineResults for all input stages and time query lines in your model.
208
153
 
209
- Args:
210
- stages (list[int]): Takes the stages by their stage number for which results should be returned.
211
- vertical_axis (TimeQueryGraphEnums): Takes the vertical axis to generate results for.
212
- apply_post_process_scaling (bool): Bool input taking whether post-process scaling should be applied or not
213
-
214
- Returns:
215
- | Returns a dictionary with key as stage number and value a list[TimeQueryLineResults] object.
216
- | To extract the unique identifier, or list[QueryLineResult] representing all node objects for this query line,
217
- | please call the supported functions from the class:
218
-
219
- * TimeQueryLineResults.GetUniqueIdentifier()
220
- * TimeQueryLineResults.GetAllNodeObjects()
221
-
222
- | To get list[QueryPointResult] denoting all the node objects at a specific node of time query line, please call:
223
-
224
- * QueryLineResult.GetNodeValues()
225
-
226
- | The above method returns list[QueryPointResult] representing all the values at this node of the time query line.
227
- | To get the x-coordiante, y-coordinate, dynamic stage time or value, please call:
228
-
229
- * QueryPointResult.GetXCoordinate()
230
- * QueryPointResult.GetYCoordinate()
231
- * QueryPointResult.GetStageTime()
232
- * QueryPointResult.GetValue()
154
+ | Please note points that are over an excavation at specific stages will not have data returned at those locations.
233
155
 
234
156
  Raises:
235
157
  ValueError: vertical_axis must be an enum of type TimeQueryGraphEnums. Any other value will raise an error.
158
+
236
159
  """
237
160
  map_data = self._callFunction('GetAllTimeQueryLinesResults',
238
161
  [stages, vertical_axis.value, apply_post_process_scaling])
@@ -249,49 +172,36 @@ class ModelProxy(ProxyObject):
249
172
  return structured_data
250
173
 
251
174
  def AddMaterialQuery(self, points: list[list[float]]) -> str:
252
- """Adds a material query point/line to your model using the specified coordinates in order.
175
+ """
176
+ :ref:`Material Query Example`
177
+
178
+ | Adds a material query point/line to your model using the specified coordinates in order.
253
179
 
254
- Returns:
255
- A unique identifier for the newly added material query point/line.
180
+ | Returns a unique identifier for the newly added material query point/line.
256
181
 
257
182
  """
258
183
  return self._callFunction('AddMaterialQuery', [points])
259
184
 
260
185
  def RemoveMaterialQuery(self, IDs_toRemove: list[str]) -> str:
261
- """Removes material query points or lines for provided list of IDs."""
186
+ """
187
+ :ref:`Material Query Example`
188
+
189
+ | Removes material query points or lines for provided list of IDs.
190
+
191
+ """
262
192
  return self._callFunction('RemoveMaterialQuery', [IDs_toRemove])
263
193
 
264
194
  def GetMaterialQueryResults(self) -> list[MaterialQueryResults]:
265
195
  """
196
+ :ref:`Material Query Example`
266
197
 
267
- | Returns the results for all the material queries defined in the model for active model stage and result type.
198
+ | Returns the results for all the material queries defined in your model for active model stage and result type.
268
199
  | To get results for a different stage, please call SetActiveStage(int stageNumber) before calling this function.
269
200
  | To get results for a different result type, please call either before calling this function:
270
201
 
271
202
  * SetResultType(InterpreterGraphEnums resultType)
272
203
  * SetUserDefinedResultType("Your defined resultType name")
273
204
 
274
- Returns:
275
- | A list[MaterialQueryResults] of query results.
276
- | To extract the Unique Identifier, Material ID for a specific material query object,
277
-
278
- please call any of the supported functions from the class:
279
-
280
- * MaterialQueryResults.GetUniqueIdentifier()
281
- * MaterialQueryResults.GetMaterialID()
282
-
283
- | To get all the results for this query, please call:
284
-
285
- * MaterialQueryResults.GetAllValues()
286
-
287
- | The above method returns list[QueryResult] for each result.
288
- | To get the x-coordiante, y-coordinate, distance or value, please call:
289
-
290
- * QueryResult.GetXCoordinate()
291
- * QueryResult.GetYCoordinate()
292
- * QueryResult.GetDistance()
293
- * QueryResult.GetValue()
294
-
295
205
  """
296
206
  all_material_query_data = self._callFunction('GetMaterialQueryResults', [])
297
207
  all_mat_query_data_as_classObj = []
@@ -302,12 +212,13 @@ class ModelProxy(ProxyObject):
302
212
  all_mat_query_data_as_classObj.append(MaterialQueryResults(*unpack_list_data))
303
213
  return all_mat_query_data_as_classObj
304
214
 
305
-
215
+ def GetBoltResults (self, stages: list[int]) -> dict[int, list[BoltResult]]:
216
+ """
217
+ :ref:`Support Bolt Results Example`
306
218
 
219
+ | Returns a map of BoltResult for all input stages and support bolt defined in your model.
307
220
 
308
- def GetBoltResults (
309
- self,
310
- stages: list[int]) -> dict[int, list[BoltResult]]:
221
+ """
311
222
  map_data = self._callFunction('GetBoltResults', [stages])
312
223
  structured_data = {}
313
224
  for stage_idx, stage_data in map_data.items():
@@ -332,7 +243,7 @@ class ModelProxy(ProxyObject):
332
243
  structured_data[stage_idx].append(bolt_result)
333
244
  return structured_data
334
245
 
335
- def process_joint_data(self, entity_data, entity_name):
246
+ def _process_joint_data(self, entity_data, entity_name):
336
247
 
337
248
  joint_element_results = []
338
249
  for joint_vector in entity_data[1]:
@@ -342,7 +253,7 @@ class ModelProxy(ProxyObject):
342
253
  joint_result = JointResult(entity_name, joint_element_results)
343
254
  return joint_result
344
255
 
345
- def process_liner_data(self, entity_data, entity_name):
256
+ def _process_liner_data(self, entity_data, entity_name):
346
257
  liner_element_results = []
347
258
 
348
259
  for liner_vector in entity_data[0]:
@@ -351,52 +262,68 @@ class ModelProxy(ProxyObject):
351
262
  liner_result = LinerResult(entity_name,liner_element_results)
352
263
  return liner_result
353
264
 
354
- def GetJointResults(
355
- self,
356
- stages: list[int]) -> dict[int, list[JointResult]]:
265
+ def GetJointResults(self, stages: list[int]) -> dict[int, list[JointResult]]:
266
+ """
267
+ :ref:`Support Joint Results Example`
268
+
269
+ | Returns a map of JointResult for all input stages and support joint defined in your model.
357
270
 
271
+ """
358
272
  map_data = self._callFunction('GetJointResults', [stages])
359
273
  structured_data = {}
360
274
  for stage_idx, stage_data in map_data.items():
361
275
 
362
276
  structured_data[stage_idx] = []
363
277
  for entity_name, entity_data in stage_data.items():
364
- joint_result = self.process_joint_data(entity_data, entity_name)
278
+ joint_result = self._process_joint_data(entity_data, entity_name)
365
279
  structured_data[stage_idx].append(joint_result)
366
280
 
367
281
  return structured_data
368
282
 
369
- def GetLinerResults(
370
- self,
371
- stages: list[int]) -> dict[int, list[LinerResult]]:
283
+ def GetLinerResults(self, stages: list[int]) -> dict[int, list[LinerResult]]:
284
+ """
285
+ :ref:`Support Liner Results Example`
286
+
287
+ | Returns a map of LinerResult for all input stages and support liner defined in your model.
372
288
 
289
+ """
373
290
  map_data = self._callFunction('GetLinerResults', [stages])
374
291
  structured_data = {}
375
292
  for stage_idx, stage_data in map_data.items():
376
293
 
377
294
  structured_data[stage_idx] = []
378
295
  for entity_name, entity_data in stage_data.items():
379
- liner_result = self.process_liner_data(entity_data, entity_name)
296
+ liner_result = self._process_liner_data(entity_data, entity_name)
380
297
  structured_data[stage_idx].append(liner_result)
381
298
 
382
299
  return structured_data
383
300
 
301
+ def GetPileResults(self, stages: list[int]) -> dict[int, list[PileResult]]:
302
+ """
303
+ :ref:`Support Pile Results Example`
304
+
305
+ | Returns a map of PileResult for all input stages and support pile defined in your model.
384
306
 
385
- def GetPileResults(
386
- self,
387
- stages: list[int]) -> dict[int, list[PileResult]]:
307
+ """
388
308
  return self._get_composition_result('GetPileResults',PileResult, stages)
389
309
 
390
- def GetCompositeResults(
391
- self,
392
- stages: list[int]) -> dict[int, list[CompositeResult]]:
310
+ def GetCompositeResults(self, stages: list[int]) -> dict[int, list[CompositeResult]]:
311
+ """
312
+ :ref:`Support Composite Results Example`
313
+
314
+ | Returns a map of CompositeResult for all input stages and support composite defined in your model.
315
+
316
+ """
393
317
  return self._get_composition_result('GetCompositeResults',CompositeResult, stages)
394
318
 
395
- def GetStructuralResults(
396
- self,
397
- stages: list[int]) -> dict[int, list[PileResult]]:
398
- return self._get_composition_result('GetStructuralResults',StructuralResult, stages)
319
+ def GetStructuralResults(self, stages: list[int]) -> dict[int, list[StructuralResult]]:
320
+ """
321
+ :ref:`Support Structural Results Example`
322
+
323
+ | Returns a map of StructuralResult for all input stages and support structural defined in your model.
399
324
 
325
+ """
326
+ return self._get_composition_result('GetStructuralResults',StructuralResult, stages)
400
327
 
401
328
  def _get_composition_result(
402
329
  self,
@@ -416,9 +343,12 @@ class ModelProxy(ProxyObject):
416
343
 
417
344
  return structured_data
418
345
 
419
- def getUnits(self):
346
+ def getUnits(self) -> Units:
420
347
  '''
421
- Get Units
348
+ :ref:`Get Model Units Example`
349
+
350
+ | Get Solid, Hydro and Thermal units for your model
351
+
422
352
  '''
423
353
  NUM_UNITS = 3
424
354
  data = self._callFunction('getUnits', [])
@@ -429,6 +359,6 @@ class ModelProxy(ProxyObject):
429
359
 
430
360
  def getCriticalSRF(self):
431
361
  '''
432
- Get Critical SRF
362
+ | Get Critical SRF
433
363
  '''
434
364
  return ResetInvalid.validate_double(self._callFunction('getCriticalSRF', []))
@@ -16,9 +16,9 @@ class JointElementResult:
16
16
  ResetInvalid.validate(self)
17
17
 
18
18
  class JointResult:
19
- def __init__(self, entity_id, joint_element_results):
19
+ def __init__(self, entity_id, joint_element_results: JointElementResult):
20
20
  self.entity_id = entity_id
21
- self.joint_element_results = joint_element_results
21
+ self.joint_element_results: JointElementResult = joint_element_results
22
22
 
23
23
 
24
24
 
@@ -28,6 +28,6 @@ class LinerElementResult:
28
28
  ResetInvalid.validate(self)
29
29
 
30
30
  class LinerResult:
31
- def __init__(self, entity_id, liner_element_results):
31
+ def __init__(self, entity_id, liner_element_results: LinerElementResult):
32
32
  self.entity_id = entity_id
33
- self.liner_element_results = liner_element_results
33
+ self.liner_element_results: LinerElementResult = liner_element_results
@@ -6,7 +6,7 @@ class MeshResults:
6
6
 
7
7
  def getXCoordinate(self, index):
8
8
  return self.results[index][0]
9
- def getYCoordiante(self, index):
9
+ def getYCoordinate(self, index):
10
10
  return self.results[index][1]
11
11
  def getValue(self, index):
12
12
  return self.results[index][2]
@@ -1,7 +1,7 @@
1
1
  from rsmessages.requestFormat import functionRequest
2
2
  from rs2._common.Client import Client
3
3
  from rs2.utilities.ApplicationManager import ApplicationManager
4
- from rs2.interpreter.InterpreterModelProxy import ModelProxy
4
+ from rs2.interpreter.InterpreterModel import Model
5
5
  import winreg
6
6
  import time
7
7
 
@@ -9,7 +9,7 @@ class RS2Interpreter:
9
9
  def __init__(self, host = 'localhost', port=60055):
10
10
  self.client = Client(host, port)
11
11
 
12
- def openFile(self, fileName : str) -> ModelProxy:
12
+ def openFile(self, fileName : str) -> Model:
13
13
  '''
14
14
  Takes in the absolute path to an rs2 file to be opened in the modeler.
15
15
 
@@ -21,8 +21,8 @@ class RS2Interpreter:
21
21
  '''
22
22
  request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
23
23
  modelObjectId = self.client.callFunction(request)
24
- modelProxy = ModelProxy(self.client, modelObjectId)
25
- return modelProxy
24
+ model = Model(self.client, modelObjectId)
25
+ return model
26
26
 
27
27
  @classmethod
28
28
  def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None: