RS2Scripting 11.24.2__tar.gz → 11.25.0__tar.gz

{rs2scripting-11.24.2/src/RS2Scripting.egg-info → rs2scripting-11.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: RS2Scripting
-Version: 11.24.2
+Version: 11.25.0
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License
@@ -102,23 +102,19 @@ To run a sub-folder of tests, navigate to the 'tests' folder, and run:
 ## Documentation
 The following steps can be taken to regenerate the RS2 Scripting Documentation:
 1. Create python a virtual environment. Navigate to the root directory of your workspace and run the commands below:  
-```python -m venv venv```
-```venv/Scripts/activate```
+```python -m venv myenv```
+```myenv\Scripts\activate```
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
-3. Run the commands below to install Sphinx and the copy button extension:  
-```python -m pip install sphinx```
-```pip install sphinx-copybutton```
-4. Install a LaTeX distribution. MiKTeX Reccomended: https://miktex.org/download   
+3. Install the documentation requirement packages.
+```pip install -r docs/requirements.txt```
+4. Run docs/example_code/runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
-Note: you may have to downgrade your ssl to an earlier version to successfuly generate the documentation ```.tex``` file. If you get an ssl error, run the following command:  
-```pip install urllib3==1.26.5```
-6. Open TeXworks (via MiKTeX) and open the documentation file:  
-	```RS2 Python Client Library\docs\_build\pdf\rs2scriptingclientlibrary.tex```
-7. In the dropdown menu, set the output to pdfLaTeX.
-8. Click the play button to generate the documentation file.
-Note: The first time you generate documentation using TeXworks, a package installation window will appear indicating that numerous packages could not be found. Deselect the "Always show this dialog" checkbox and click the install button. 
-9. The Documentation in PDF format will be located here: ```RS2 Python Client Library\docs/_build/pdf/rs2scriptingclientlibrary.pdf```
+
+"examples.rst" and "index.rst" files are manually written and should be manually modified. "generateAndBuildDocumentation.py" will not overwrite them.
+
+Rocscience logo is saved under _static folder.
+
 
 ### Adding To Documentation
 The following steps can be taken to add a new proxy object to the autogenerated documentation:

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/README.md

@@ -85,23 +85,19 @@ To run a sub-folder of tests, navigate to the 'tests' folder, and run:
 ## Documentation
 The following steps can be taken to regenerate the RS2 Scripting Documentation:
 1. Create python a virtual environment. Navigate to the root directory of your workspace and run the commands below:  
-```python -m venv venv```
-```venv/Scripts/activate```
+```python -m venv myenv```
+```myenv\Scripts\activate```
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
-3. Run the commands below to install Sphinx and the copy button extension:  
-```python -m pip install sphinx```
-```pip install sphinx-copybutton```
-4. Install a LaTeX distribution. MiKTeX Reccomended: https://miktex.org/download   
+3. Install the documentation requirement packages.
+```pip install -r docs/requirements.txt```
+4. Run docs/example_code/runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
-Note: you may have to downgrade your ssl to an earlier version to successfuly generate the documentation ```.tex``` file. If you get an ssl error, run the following command:  
-```pip install urllib3==1.26.5```
-6. Open TeXworks (via MiKTeX) and open the documentation file:  
-	```RS2 Python Client Library\docs\_build\pdf\rs2scriptingclientlibrary.tex```
-7. In the dropdown menu, set the output to pdfLaTeX.
-8. Click the play button to generate the documentation file.
-Note: The first time you generate documentation using TeXworks, a package installation window will appear indicating that numerous packages could not be found. Deselect the "Always show this dialog" checkbox and click the install button. 
-9. The Documentation in PDF format will be located here: ```RS2 Python Client Library\docs/_build/pdf/rs2scriptingclientlibrary.pdf```
+
+"examples.rst" and "index.rst" files are manually written and should be manually modified. "generateAndBuildDocumentation.py" will not overwrite them.
+
+Rocscience logo is saved under _static folder.
+
 
 ### Adding To Documentation
 The following steps can be taken to add a new proxy object to the autogenerated documentation:

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "RS2Scripting"
-version = "11.24.2"
+version = "11.25.0"
 dependencies = [
   "rsmessages == 0.0.2"
 ]

{rs2scripting-11.24.2 → rs2scripting-11.25.0/src/RS2Scripting.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: RS2Scripting
-Version: 11.24.2
+Version: 11.25.0
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License
@@ -102,23 +102,19 @@ To run a sub-folder of tests, navigate to the 'tests' folder, and run:
 ## Documentation
 The following steps can be taken to regenerate the RS2 Scripting Documentation:
 1. Create python a virtual environment. Navigate to the root directory of your workspace and run the commands below:  
-```python -m venv venv```
-```venv/Scripts/activate```
+```python -m venv myenv```
+```myenv\Scripts\activate```
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
-3. Run the commands below to install Sphinx and the copy button extension:  
-```python -m pip install sphinx```
-```pip install sphinx-copybutton```
-4. Install a LaTeX distribution. MiKTeX Reccomended: https://miktex.org/download   
+3. Install the documentation requirement packages.
+```pip install -r docs/requirements.txt```
+4. Run docs/example_code/runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
-Note: you may have to downgrade your ssl to an earlier version to successfuly generate the documentation ```.tex``` file. If you get an ssl error, run the following command:  
-```pip install urllib3==1.26.5```
-6. Open TeXworks (via MiKTeX) and open the documentation file:  
-	```RS2 Python Client Library\docs\_build\pdf\rs2scriptingclientlibrary.tex```
-7. In the dropdown menu, set the output to pdfLaTeX.
-8. Click the play button to generate the documentation file.
-Note: The first time you generate documentation using TeXworks, a package installation window will appear indicating that numerous packages could not be found. Deselect the "Always show this dialog" checkbox and click the install button. 
-9. The Documentation in PDF format will be located here: ```RS2 Python Client Library\docs/_build/pdf/rs2scriptingclientlibrary.pdf```
+
+"examples.rst" and "index.rst" files are manually written and should be manually modified. "generateAndBuildDocumentation.py" will not overwrite them.
+
+Rocscience logo is saved under _static folder.
+
 
 ### Adding To Documentation
 The following steps can be taken to add a new proxy object to the autogenerated documentation:

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/RS2Scripting.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ src/rs2/modeler/properties/AbsoluteStageFactorGettersInterface.py
 src/rs2/modeler/properties/AbsoluteStageFactorInterface.py
 src/rs2/modeler/properties/CompositeProperty.py
 src/rs2/modeler/properties/DiscreteFunction.py
+src/rs2/modeler/properties/HydroDistributionFunction.py
 src/rs2/modeler/properties/MaterialJoint.py
 src/rs2/modeler/properties/MaterialJointOptions.py
 src/rs2/modeler/properties/PropertyEnums.py
@@ -81,6 +82,7 @@ src/rs2/modeler/properties/material/datum/PeakResidualDatum.py
 src/rs2/modeler/properties/material/datum/SimpleDatum.py
 src/rs2/modeler/properties/material/datum/__init__.py
 src/rs2/modeler/properties/material/hydraulic/Hydraulic.py
+src/rs2/modeler/properties/material/hydraulic/HydroDistribution.py
 src/rs2/modeler/properties/material/hydraulic/StaticGroundwater.py
 src/rs2/modeler/properties/material/hydraulic/__init__.py
 src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/Brooks.py

rs2scripting-11.25.0/src/rs2/BaseModel.py

@@ -0,0 +1,83 @@
+from rs2._common.ProxyObject import ProxyObject
+from rs2._common.documentProxy import DocumentProxy
+from rs2.Units import Units
+class BaseModel(ProxyObject):
+
+	def __init__(self, client, ID):
+		super().__init__(client, ID)
+		self._documentProxy = self._getDocument()
+
+	def _getDocument(self):
+		documentObjectID = self._callFunction('getDocument', [], keepReturnValueReference=True)
+		return DocumentProxy(self._client, documentObjectID)
+	
+	def _enforceFeaFezEnding(self, path: str):
+		if not (path.endswith('.fea') or path.endswith('.fez')):
+			raise ValueError('Path must end with .fea or .fez')
+		
+	def close(self):
+		'''
+		Closes the model
+		
+		Examples:
+	
+			.. code::
+		
+			   model.close()
+		   
+			See a full example in :ref:`Model Example`.
+		
+		'''
+		return self._callFunction('close', [])
+	
+	def save(self):
+		'''
+		Saves the model
+		
+		Examples:
+	
+			.. code::
+		
+			   model.save()
+		   
+			See a full example in :ref:`Model Example`.
+
+		'''
+		return self._callFunction('save', [])
+	
+	def getUnits(self):
+		'''
+		
+		Get Solid, Hydro and Thermal units for your model from RS2Modeler or RS2Interpreter.
+		
+		See Also:
+			Each of solid units, hydro units and thermal units of your model can be accessed through `rs2.Units <rs2.Units.html>`_.
+		
+		Examples:
+		
+			.. code-block:: python
+		
+				modeler = RS2Modeler()			
+				model = modeler.openFile(rf"{current_dir}\example_models\SupportStructuralResults.fez")
+				# Get Solid, Hydro and Thermal units of your model
+				modelerUnits = model.getUnits()
+				print("\\nModeler Units")
+				print("\\nSolid Units :")
+				# Get solid units
+				pprint(modelerUnits.solid_units)
+				print("\\nHydro Units :")
+				# Get hydro units
+				pprint(modelerUnits.hydro_units)
+				print("\\nThermal Units :")
+				# Get thermal units
+				pprint(modelerUnits.thermal_units)
+			
+			See a full example in :ref:`Get Model Units Example`
+
+
+		'''
+		NUM_UNITS = 3
+		data = self._callFunction('getUnits', [])
+		if (len (data) !=NUM_UNITS) :
+			assert False, "Expected 3 units, got " + str(len(data))
+		return Units(*data)

rs2scripting-11.25.0/src/rs2/Units.py

@@ -0,0 +1,35 @@
+
+class Units:
+	"""
+	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.
+		
+	Examples:
+	
+		.. code-block:: python
+		
+			modeler = RS2Modeler()			
+			model = modeler.openFile(rf"{current_dir}\example_models\SupportStructuralResults.fez")
+			# Get Solid, Hydro and Thermal units of your model
+			modelerUnits = model.getUnits()
+			print("\\nModeler Units")
+			print("\\nSolid Units :")
+			# Get solid units
+			pprint(modelerUnits.solid_units)
+			print("\\nHydro Units :")
+			# Get hydro units
+			pprint(modelerUnits.hydro_units)
+			print("\\nThermal Units :")
+			# Get thermal units
+			pprint(modelerUnits.thermal_units)
+			
+		See a full example in :ref:`Get Model Units Example`.
+		
+		
+	"""
+	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.24.2 → rs2scripting-11.25.0}/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.024"
+		self.compatibleProgramVersion = "11.025"
 		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.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/InterpreterEnums.py

@@ -28,6 +28,11 @@ class ExportResultType(Enum):
 	SEEPAGE_TOTAL_HYDRAULIC_GRADIENT = "INTERPRET_HYD_GRAD_TOTAL"
 	SEEPAGE_HORIZONTAL_PERMEABILITY = "INTERPRET_PERMEABILITY_X"
 	SEEPAGE_VERTICAL_PERMEABILITY = "INTERPRET_PERMEABILITY_Y"
+	SEEPAGE_SPATIAL_PERM = "INTERPRET_SPATIAL_PERM"
+	SEEPAGE_SPATIAL_WC = "INTERPRET_SPATIAL_WC"
+	SEEPAGE_SPATIAL_WC_RES = "INTERPRET_SPATIAL_WC_R"
+	SEEPAGE_SPATIAL_CONDY = "INTERPRET_SPATIAL_CONDY"
+	SEEPAGE_SPATIAL_ANGLE= "INTERPRET_SPATIAL_ANGLE"
 	SEEPAGE_YIELDED_ELEMENTS = "INTERPRET_YIELDED_ELEMENTS"
 	SOLID_STRAIN_VOLUMETRIC_STRAIN = "INTERPRET_STRAIN_VOLUMETRIC"
 	SOLID_STRAIN_MAX_SHEAR_STRAIN = "INTERPRET_STRAIN_MAX_SHEAR"

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/InterpreterGraphEnums.py

@@ -1,5 +1,11 @@
 from enum import Enum, auto
 class HistoryQueryGraphEnums():
+    """
+    Set the history query graph.
+    
+    """
+
+
     class VerticalAxisTypes(Enum):
         HORIZONTAL_DISPLACEMENT = 4070
         VERTICAL_DISPLACEMENT = 4071
@@ -14,8 +20,8 @@ class HistoryQueryGraphEnums():
         STRAIN_XX = 4080
         STRAIN_YY = 4081
         STRAIN_XY = 4082
-        EXCESS_PORE_PRESSURE = 4083
         # Water
+        EXCESS_PORE_PRESSURE = 4083
         PORE_PRESSURE = 4084
         HORIZONTAL_HYDRAULIC_VELOCITY = 4085
         VERTICAL_HYDRAULIC_VELOCITY = 4086
@@ -33,6 +39,10 @@ class HistoryQueryGraphEnums():
         STAGE_LOAD_PERCENTAGE = 9096
 
 class TimeQueryGraphEnums():
+    """
+    Set the time query graph.
+    
+    """
     class VerticalAxisTypes(Enum):
         X_VELOCITY = 4041
         X_DISPLACEMENT = 4042

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/InterpreterModel.py

@@ -18,11 +18,10 @@ class Model(BaseModel):
 		'''
 		Saves the model using the given file name.
 
-		Example:
-
-		.. code-block:: python
+		Examples:
+			.. code-block:: python
 			
-			model.saveCopyAs('C:/simple_3_stage.fez')
+				model.saveCopyAs('C:/simple_3_stage.fez')
 		'''
 		formattedFileName = fileName.replace('/', '\\')
 		self._enforceFeaFezEnding(formattedFileName)

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/RS2Interpreter.py

@@ -13,11 +13,10 @@ class RS2Interpreter:
 		'''
 		Takes in the absolute path to an rs2 file to be opened in the modeler.
 
-		Example:
-
-		.. code-block:: python
+		Examples:
+			.. code-block:: python
 			
-			model = modeler.openFile('C:/simple_3_stage.fez')
+				model = modeler.openFile('C:/simple_3_stage.fez')
 		'''
 		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
 		modelObjectId = self.client.callFunction(request)
@@ -56,15 +55,14 @@ class RS2Interpreter:
 		'''
 		Closes the modeler program. All unsaved models are saved by default.
 
-		Example:
-
-		.. code-block:: python
+		Examples:
+			.. code-block:: python
 			
-			#Saves all models before closing
-			modeler.closeProgram(True)
+				#Saves all models before closing
+				modeler.closeProgram(True)
 
-			#Closes without saving any models
-			modeler.closeProgram(False)
+				#Closes without saving any models
+				modeler.closeProgram(False)
 		'''
 		request = functionRequest('closeProgram', [saveModels])
 		portUsed = self.client.callFunction(request)

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/queryResults/HistoryQueryResults.py

@@ -1,14 +1,18 @@
 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.
+    This class shows History Query Result.
+    
+    Attributes:
+        x_location (double): X-Coordinate for history query point.
+        y_location (double): Y-Coordinate for history query point.
+        horizontal_axis_result (double): Horizontal Axis Result for history query point.
+        vertical_axis_result (double): Vertical Axis Result for history query point.        
+    
+    
+    Examples:
+        :ref:`History Query Example`
 	"""
+    
     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.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/queryResults/MaterialQueryResults.py

@@ -2,14 +2,17 @@ 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.
+
+    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.
+    
+    Examples:
+    
+		:ref:`Material Query Example`
+        
 	"""
     def __init__(self, x_location, y_location, distance, value):
         self.x_location = x_location
@@ -44,13 +47,15 @@ class QueryResult:
 
 class MaterialQueryResults:
     """
-	Examples:
-		:ref:`Material Query Example`
-	
-	Attributes:
+    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.
+     
+        
+    Examples:
+    
+		:ref:`Material Query Example`
 	"""
     def __init__(self, entity_ID, material_id, query_values):
         self.entity_ID = entity_ID

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/queryResults/MeshResults.py

@@ -1,10 +1,14 @@
 class MeshResults:
     """
-	Examples:
-		:ref:`Get Mesh Results Example`
 	
-	Attributes:
+    Attributes:
         results (list[list[double]]): Mesh results containing x-coordinate, y-coordinate and result type value for each node in your model.
+        
+        
+    Examples:
+    
+		:ref:`Get Mesh Results Example`
+        
 	"""
     results = None
 

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/queryResults/TimeQueryResults.py

@@ -1,13 +1,18 @@
 class QueryPointResult:
     """
-	Examples:
-		:ref:`Time Query Example`
-	
-	Attributes:
+    Returns query point result.
+    
+    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.
+    
+        
+    Examples:
+    
+		:ref:`Time Query Example`    
+        
 	"""
     def __init__(self, x_location, y_location, time, value):
         self.x_location = x_location
@@ -41,11 +46,11 @@ class QueryPointResult:
 
 class QueryLineResult:
     """
-	Examples:
-		:ref:`Time Query Example`
-	
-	Attributes:
+    Attributes:
         query_values (list[QueryPointResult]): List of QueryPointResult objects making up the result for the time query line.
+    
+    Examples:
+		:ref:`Time Query Example`
 	"""
     def __init__(self, list_node_values):
         list_node_value_obj = []
@@ -67,12 +72,12 @@ class QueryLineResult:
 
 class TimeQueryPointResults:
     """
-	Examples:
-		:ref:`Time Query Example`
-	
-	Attributes:
+    Attributes:
         entity_ID (str): Unique Identifier for time query point.
         query_values (list[QueryPointResult]): List of QueryPointResult object for time query point.
+        
+    Examples:
+		:ref:`Time Query Example`
 	"""
     # Stores all time query points result for specific stage
     def __init__(self, entity_ID, query_point_values):
@@ -103,12 +108,12 @@ class TimeQueryPointResults:
 
 class TimeQueryLineResults:
     """
-	Examples:
-		:ref:`Time Query Example`
-	
-	Attributes:
+    Attributes:
         entity_ID (str): Unique Identifier for time query line.
         line_data (list[QueryLineResult]): List of QueryLineResult object for time query line.
+     
+    Examples:
+		:ref:`Time Query Example`
 	"""
     # Stores all time query line result for specific stage
     def __init__(self, entity_ID, list_query_line_data):

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/supportResults/BoltResult.py

@@ -11,15 +11,16 @@ class BoltElementYieldStatus(Enum):
   
 class BoltYieldingResult:
     """
-	Examples:
-		:ref:`Support Bolt Results Example`
-	
-	Attributes:
+    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.
+
+    Examples:
+		:ref:`Support Bolt Results Example`
+        
 	"""
     def __init__(self, start_x, start_y, end_x, end_y, yielding_flag):
         self.start_x = start_x #0
@@ -32,10 +33,8 @@ class BoltYieldingResult:
 
 class BoltForceDisplacementResult:
     """
-	Examples:
-		:ref:`Support Bolt Results Example`
-	
-	Attributes:
+
+    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.
@@ -44,6 +43,9 @@ class BoltForceDisplacementResult:
         shear_force (double): Shear Force for support bolt.
         rock_displacement (double): Rock Displacement for support bolt.
         bolt_displacement (double): Bolt Displacement for support bolt.
+        
+    Examples:
+		:ref:`Support Bolt Results Example`
 	"""
     def __init__(self, location_x, location_y, distance, axial_force, axial_stress, shear_force, rock_displacement, bolt_displacement):
         self.location_x = location_x #0
@@ -58,10 +60,8 @@ class BoltForceDisplacementResult:
 
 class BoltResult:
     """
-	Examples:
-		:ref:`Support Bolt Results Example`
 	
-	Attributes:
+    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.
@@ -69,7 +69,11 @@ class BoltResult:
         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.
-	"""
+	
+    Examples:
+		:ref:`Support Bolt Results Example`
+        
+    """
     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'

{rs2scripting-11.24.2 → rs2scripting-11.25.0}/src/rs2/interpreter/supportResults/CompositeResult.py

@@ -3,13 +3,14 @@ from rs2.interpreter.supportResults.JointResult import JointResult
 
 class PileResult:
     """
-	Examples:
-		:ref:`Support Pile Results Example`
-	
-	Attributes:
+    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.
+        
+    Examples:
+    
+		:ref:`Support Pile Results Example`
 	"""
     def __init__(self, entity_id, joint_result: list[JointResult], liner_result: list[LinerResult]):
         self.entity_id = entity_id
@@ -18,13 +19,14 @@ class PileResult:
 
 class CompositeResult:
     """
-	Examples:
-		:ref:`Support Composite Results Example`
-	
-	Attributes:
+    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.
+	
+    Examples:
+    
+		:ref:`Support Composite Results Example`
 	"""
     def __init__(self, entity_id, joint_result: list[JointResult], liner_result: list[LinerResult]):
         self.entity_id = entity_id
@@ -33,13 +35,15 @@ class CompositeResult:
 
 class StructuralResult:
     """
-	Examples:
-		:ref:`Support Structural Results Example`
-	
-	Attributes:
+    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.
+    
+    Examples:
+    
+		:ref:`Support Structural Results Example`
+        
 	"""
     def __init__(self, entity_id, joint_result: list[JointResult], liner_result: list[LinerResult]):
         self.entity_id = entity_id