RS2Scripting 11.23.0rc1__tar.gz → 11.24.1__tar.gz

{RS2Scripting-11.23.0rc1/src/RS2Scripting.egg-info → rs2scripting-11.24.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: RS2Scripting
-Version: 11.23.0rc1
+Version: 11.24.1
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License
@@ -13,7 +13,7 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: License.txt
-Requires-Dist: rsmessages==0.0.2rc1
+Requires-Dist: rsmessages==0.0.2
 
 ## Introduction 
 This project is a library that can be used to interact with RS2 through python.  
@@ -47,9 +47,9 @@ The current set of functionality exposed is limited. With this version of the li
 ## Getting Started
 
 **Getting started guide**  
-<!---TODO: add link-->
+https://www.rocscience.com/help/rs2/tutorials/scripting/getting-started-with-rs2-python-scripting  
 **First Tutorial**  
-<!---TODO: add link-->
+https://www.rocscience.com/help/rs2/tutorials/scripting/anchored-sheet-pile-wall
 
 # For Contributors:
 

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/README.md

@@ -30,9 +30,9 @@ The current set of functionality exposed is limited. With this version of the li
 ## Getting Started
 
 **Getting started guide**  
-<!---TODO: add link-->
+https://www.rocscience.com/help/rs2/tutorials/scripting/getting-started-with-rs2-python-scripting  
 **First Tutorial**  
-<!---TODO: add link-->
+https://www.rocscience.com/help/rs2/tutorials/scripting/anchored-sheet-pile-wall
 
 # For Contributors:
 

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/pyproject.toml

@@ -4,9 +4,9 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "RS2Scripting"
-version = "11.23.0rc1"
+version = "11.24.1"
 dependencies = [
-  "rsmessages == 0.0.2rc1"
+  "rsmessages == 0.0.2"
 ]
 authors = [
   { name="Rocscience"},

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1/src/RS2Scripting.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: RS2Scripting
-Version: 11.23.0rc1
+Version: 11.24.1
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License
@@ -13,7 +13,7 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: License.txt
-Requires-Dist: rsmessages==0.0.2rc1
+Requires-Dist: rsmessages==0.0.2
 
 ## Introduction 
 This project is a library that can be used to interact with RS2 through python.  
@@ -47,9 +47,9 @@ The current set of functionality exposed is limited. With this version of the li
 ## Getting Started
 
 **Getting started guide**  
-<!---TODO: add link-->
+https://www.rocscience.com/help/rs2/tutorials/scripting/getting-started-with-rs2-python-scripting  
 **First Tutorial**  
-<!---TODO: add link-->
+https://www.rocscience.com/help/rs2/tutorials/scripting/anchored-sheet-pile-wall
 
 # For Contributors:
 

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/src/RS2Scripting.egg-info/SOURCES.txt

@@ -200,4 +200,5 @@ tests/testModelerSingleFileCloseProgram.py
 tests/testOpenFileNoResults.py
 tests/testSaveAs.py
 tests/testShearNormalFunction.py
-tests/testSnowdenAnisotropicFunction.py
+tests/testSnowdenAnisotropicFunction.py
+tests/testStiffnessYoungModulusE1EZFactor.py

rs2scripting-11.24.1/src/RS2Scripting.egg-info/requires.txt

@@ -0,0 +1 @@
+rsmessages==0.0.2

rs2scripting-11.24.1/src/rs2/Units.py

@@ -0,0 +1,15 @@
+
+class Units:
+	"""
+	Examples:
+		:ref:`Get Model Units Example`
+	
+	Attributes:
+        solid_units (list[tuple[str]]): List of all solid units for your model.
+        hydro_units (list[tuple[str]]): List of all hydraulic units for your model.
+        thermal_units (list[tuple[str]]): List of all thermal units for your model.
+	"""
+	def __init__(self, solid_units=None, hydro_units=None, thermal_units=None):
+		self.solid_units = solid_units
+		self.hydro_units = hydro_units
+		self.thermal_units = thermal_units

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/src/rs2/_common/Client.py

@@ -5,7 +5,7 @@ from multiprocessing.connection import Client as multiProcessingClient
 
 class Client:
 	def __init__(self, host, port):
-		self.compatibleProgramVersion = "11.023"
+		self.compatibleProgramVersion = "11.024"
 		self.connection = self.establishConnection(host, port)
 		if self.connection == None:
 			raise RuntimeError("Could not establish connection with the server. Make sure the server is started on the application.")

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/src/rs2/interpreter/queryResults/HistoryQueryResults.py

@@ -1,4 +1,14 @@
 class HistoryQueryResult:
+    """
+	Examples:
+		:ref:`History Query Example`
+	
+	Attributes:
+		horizontal_axis_result (double): Horizontal Axis Result for history query point.
+        vertical_axis_result (double): Vertical Axis Result for history query point.
+        location_x (double): X-Coordinate for history query point.
+        location_y (double): Y-Coordinate for history query point.
+	"""
     def __init__(self, x_location, y_location, horizontal_axis_result, vertical_axis_result):
         self.horizontal_axis_result = horizontal_axis_result
         self.vertical_axis_result = vertical_axis_result

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/src/rs2/interpreter/queryResults/MaterialQueryResults.py

@@ -1,6 +1,16 @@
 from rs2.interpreter._UtilityResult import *
 
 class QueryResult:
+    """
+	Examples:
+		:ref:`Material Query Example`
+	
+	Attributes:
+        x_location (double): X-Coordinate for material query point.
+        y_location (double): Y-Coordinate for material query point.
+        distance (double): Distance for material query point.
+        value (double): Result type value for material query point.
+	"""
     def __init__(self, x_location, y_location, distance, value):
         self.x_location = x_location
         self.y_location = y_location
@@ -33,6 +43,15 @@ class QueryResult:
         return self.value
 
 class MaterialQueryResults:
+    """
+	Examples:
+		:ref:`Material Query Example`
+	
+	Attributes:
+        entity_ID (str): Unique Identifier for material query.
+        material_id (int): Material Identifier for material query.
+        query_values (list[QueryResult]): List of QueryResult point objects making up the material query.
+	"""
     def __init__(self, entity_ID, material_id, query_values):
         self.entity_ID = entity_ID
         self.material_id = material_id

rs2scripting-11.24.1/src/rs2/interpreter/queryResults/MeshResults.py

@@ -0,0 +1,28 @@
+class MeshResults:
+    """
+	Examples:
+		:ref:`Get Mesh Results Example`
+	
+	Attributes:
+        results (list[list[double]]): Mesh results containing x-coordinate, y-coordinate and result type value for each node in your model.
+	"""
+    results = None
+
+    def __init__(self, results):
+        self.results = results
+
+    def getXCoordinate(self, index):
+        '''
+        Returns the X-Coordinate of the mesh node for specified index
+        '''
+        return self.results[index][0]
+    def getYCoordinate(self, index):
+        '''
+        Returns the Y-Coordinate of the mesh node for specified index
+        '''
+        return self.results[index][1]
+    def getValue(self, index):
+        '''
+        Returns the value of the mesh node based on model's current result type and specified index
+        '''
+        return self.results[index][2]

{RS2Scripting-11.23.0rc1 → rs2scripting-11.24.1}/src/rs2/interpreter/queryResults/TimeQueryResults.py

@@ -1,35 +1,52 @@
 class QueryPointResult:
-        def __init__(self, x_location, y_location, time, value):
-            self.x_location = x_location
-            self.y_location = y_location
-            self.time = time
-            self.value = value
-        
-        def GetXCoordinate(self) -> float:
-            '''
-            Returns the X-Coordinate of the query point
-            '''
-            return self.x_location
+    """
+	Examples:
+		:ref:`Time Query Example`
+	
+	Attributes:
+        x_location (double): X-Coordinate for time query point.
+        y_location (double): Y-Coordinate for time query point.
+        time (double): Dynamic stage time for time query point.
+        value (double): Value for time query point.
+	"""
+    def __init__(self, x_location, y_location, time, value):
+        self.x_location = x_location
+        self.y_location = y_location
+        self.time = time
+        self.value = value
     
-        def GetYCoordinate(self) -> float:
-            '''
-            Returns the Y-Coordinate of the query point
-            '''
-            return self.y_location
+    def GetXCoordinate(self) -> float:
+        '''
+        Returns the X-Coordinate of the query point
+        '''
+        return self.x_location
 
-        def GetStageTime(self) -> float:
-            '''
-            Returns the dynamic stage time of the query point
-            '''
-            return self.time
-        
-        def GetValue(self) -> float:
-            '''
-            Returns the value of the time query point
-            '''
-            return self.value
+    def GetYCoordinate(self) -> float:
+        '''
+        Returns the Y-Coordinate of the query point
+        '''
+        return self.y_location
+
+    def GetStageTime(self) -> float:
+        '''
+        Returns the dynamic stage time of the query point
+        '''
+        return self.time
+    
+    def GetValue(self) -> float:
+        '''
+        Returns the value of the time query point
+        '''
+        return self.value
 
 class QueryLineResult:
+    """
+	Examples:
+		:ref:`Time Query Example`
+	
+	Attributes:
+        query_values (list[QueryPointResult]): List of QueryPointResult objects making up the result for the time query line.
+	"""
     def __init__(self, list_node_values):
         list_node_value_obj = []
         for node_value in list_node_values:
@@ -49,6 +66,14 @@ class QueryLineResult:
         return self.query_values
 
 class TimeQueryPointResults:
+    """
+	Examples:
+		:ref:`Time Query Example`
+	
+	Attributes:
+        entity_ID (str): Unique Identifier for time query point.
+        query_values (list[QueryPointResult]): List of QueryPointResult object for time query point.
+	"""
     # Stores all time query points result for specific stage
     def __init__(self, entity_ID, query_point_values):
         self.entity_ID = entity_ID
@@ -77,6 +102,14 @@ class TimeQueryPointResults:
         return self.query_values
 
 class TimeQueryLineResults:
+    """
+	Examples:
+		:ref:`Time Query Example`
+	
+	Attributes:
+        entity_ID (str): Unique Identifier for time query line.
+        line_data (list[QueryLineResult]): List of QueryLineResult object for time query line.
+	"""
     # Stores all time query line result for specific stage
     def __init__(self, entity_ID, list_query_line_data):
         self.entity_ID = entity_ID

rs2scripting-11.24.1/src/rs2/interpreter/supportResults/BoltResult.py

@@ -0,0 +1,87 @@
+from enum import Enum
+from rs2.interpreter._UtilityResult import *
+
+class BoltElementYieldStatus(Enum):
+    BOLT_ELEMENT_NOT_YIELDED = 0
+    BOLT_ELEMENT_TYPE_UNKNOWN_YIELDED  = 1
+    BOLT_ELEMENT_TENSION_YIELDED = 2
+    BOLT_ELEMENT_SHEAR_YIELDED  = 4
+    BOLT_ELEMENT_TENSIONANDSHEAR_YIELDED = BOLT_ELEMENT_TENSION_YIELDED + BOLT_ELEMENT_SHEAR_YIELDED
+    BOLT_ELEMENT_UNDEFINED_YIELDED = -1
+  
+class BoltYieldingResult:
+    """
+	Examples:
+		:ref:`Support Bolt Results Example`
+	
+	Attributes:
+        start_x (double): Start X-Coordinate for support bolt.
+        start_y (double): Start Y-Coordinate for support bolt.
+        end_x (double): End X-Coordinate for support bolt.
+        end_y (double): End Y-Coordinate for support bolt.
+        yielding_flag (BoltElementYieldStatus): Enum representing bolt yielded status.
+	"""
+    def __init__(self, start_x, start_y, end_x, end_y, yielding_flag):
+        self.start_x = start_x #0
+        self.start_y = start_y #1
+        self.end_x = end_x #2
+        self.end_y = end_y #3
+        self.yielding_flag = BoltElementYieldStatus(yielding_flag) #4
+        ResetInvalid.validate(self)
+
+
+class BoltForceDisplacementResult:
+    """
+	Examples:
+		:ref:`Support Bolt Results Example`
+	
+	Attributes:
+        location_x (double): Start X-Coordinate for support bolt.
+        location_y (double): Start Y-Coordinate for support bolt.
+        distance (double): Distance of support bolt.
+        axial_force (double): Axial Force for support bolt.
+        axial_stress (double): Axial Stress for support bolt.
+        shear_force (double): Shear Force for support bolt.
+        rock_displacement (double): Rock Displacement for support bolt.
+        bolt_displacement (double): Bolt Displacement for support bolt.
+	"""
+    def __init__(self, location_x, location_y, distance, axial_force, axial_stress, shear_force, rock_displacement, bolt_displacement):
+        self.location_x = location_x #0
+        self.location_y = location_y #1
+        self.distance = distance #2
+        self.axial_force = axial_force #3
+        self.axial_stress = axial_stress #4
+        self.shear_force = shear_force #5
+        self.rock_displacement = rock_displacement #6
+        self.bolt_displacement = bolt_displacement #7
+        ResetInvalid.validate(self)
+
+class BoltResult:
+    """
+	Examples:
+		:ref:`Support Bolt Results Example`
+	
+	Attributes:
+        entity_id (str): Unique Identifier for support bolt.
+        start_x (double): Start X-Coordinate for support bolt.
+        start_y (double): Start Y-Coordinate for support bolt.
+        end_x (double): End X-Coordinate for support bolt.
+        end_y (double): End Y-Coordinate for support bolt.
+        yielding_results (list[BoltYieldingResult]): List of bolt yielding result for support bolt.
+        force_displacement_results (list[BoltForceDisplacementResult]): List of bolt force displacement result for support bolt.
+	"""
+    def __init__(self, entity_id, entity_data, yielding_results: list[BoltYieldingResult], force_displacement_results: list[BoltForceDisplacementResult]):
+        if len(entity_data) == 0 or len(entity_data[0]) == 0:
+            assert False, 'location not defined'
+            return
+        location_tensor = entity_data[0][0]
+        start_x, start_y, end_x, end_y = location_tensor
+
+        self.entity_id = entity_id
+        self.start_x = start_x
+        self.start_y = start_y
+        self.end_x = end_x
+        self.end_y = end_y
+        self.yielding_results: list[BoltYieldingResult] = yielding_results
+        self.force_displacement_results: list[BoltForceDisplacementResult] = force_displacement_results
+

rs2scripting-11.24.1/src/rs2/interpreter/supportResults/CompositeResult.py

@@ -0,0 +1,51 @@
+from rs2.interpreter.supportResults.LinerResult import LinerResult
+from rs2.interpreter.supportResults.JointResult import JointResult
+
+class PileResult:
+    """
+	Examples:
+		:ref:`Support Pile Results Example`
+	
+	Attributes:
+        entity_id (str): Unique Identifier for support pile.
+        joint_result (list[JointResult]): List of all joint results for support pile.
+        liner_result (list[LinerResult]): List of all liner results for support pile.
+	"""
+    def __init__(self, entity_id, joint_result: list[JointResult], liner_result: list[LinerResult]):
+        self.entity_id = entity_id
+        self.joint_result: list[JointResult] = joint_result
+        self.liner_result: list[LinerResult] = liner_result
+
+class CompositeResult:
+    """
+	Examples:
+		:ref:`Support Composite Results Example`
+	
+	Attributes:
+        entity_id (str): Unique Identifier for support composite.
+        joint_result (list[JointResult]): List of all joint results for support composite.
+        liner_result (list[LinerResult]): List of all liner results for support composite.
+	"""
+    def __init__(self, entity_id, joint_result: list[JointResult], liner_result: list[LinerResult]):
+        self.entity_id = entity_id
+        self.joint_result: list[JointResult] = joint_result
+        self.liner_result: list[LinerResult] = liner_result
+
+class StructuralResult:
+    """
+	Examples:
+		:ref:`Support Structural Results Example`
+	
+	Attributes:
+        entity_id (str): Unique Identifier for support structural.
+        joint_result (list[JointResult]): List of all joint results for support structural.
+        liner_result (list[LinerResult]): List of all liner results for support structural.
+	"""
+    def __init__(self, entity_id, joint_result: list[JointResult], liner_result: list[LinerResult]):
+        self.entity_id = entity_id
+        self.joint_result: list[JointResult] = joint_result
+        self.liner_result: list[LinerResult] = liner_result
+
+
+
+

rs2scripting-11.24.1/src/rs2/interpreter/supportResults/JointResult.py

@@ -0,0 +1,50 @@
+from rs2.interpreter._UtilityResult import *
+
+class JointElementResult:
+    """
+	Examples:
+		:ref:`Support Joint Results Example`
+	
+	Attributes:
+        start_x (double): Start X-Coordinate for support joint.
+        start_y (double): Start Y-Coordinate for support joint.
+        end_x (double): End X-Coordinate for support joint.
+        end_y (double): End Y-Coordinate for support joint.
+        distance (double): Distance of support joint.
+        normal_stress (double): Normal Stress for support joint.
+        shear_stress (double): Shear Stress for support joint.
+        confining_stress (double): Confining Stress for support joint.
+        normal_displacement (double): Normal Displacement for support joint.
+        shear_displacement (double): Shear Displacement for support joint.
+        yielded (bool): Boolean representing yielded status for support joint.
+	"""
+    def __init__(self, start_x, start_y, end_x, end_y, distance, normal_stress, shear_stress,confining_stress, normal_displacement, shear_displacement, yielded):
+        self.start_x = start_x
+        self.start_y = start_y
+        self.end_x = end_x
+        self.end_y = end_y
+        self.distance = distance
+        self.normal_stress = normal_stress
+        self.shear_stress = shear_stress
+        self.confining_stress = confining_stress
+        self.normal_displacement = normal_displacement
+        self.shear_displacement = shear_displacement
+        self.yielded = bool(yielded)
+        ResetInvalid.validate(self)
+
+class JointResult:
+    """
+	Examples:
+		:ref:`Support Joint Results Example`
+	
+	Attributes:
+        entity_id (str): Unique Identifier for support joint.
+        joint_element_results (list[JointElementResult]): List of all joint element result for support joint.
+	"""
+    def __init__(self, entity_id, joint_element_results: list[JointElementResult]):
+        self.entity_id = entity_id
+        self.joint_element_results: list[JointElementResult] = joint_element_results
+
+
+
+