RS2Scripting 11.27.0__tar.gz → 11.29.0__tar.gz

{rs2scripting-11.27.0/src/RS2Scripting.egg-info → rs2scripting-11.29.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: RS2Scripting
-Version: 11.27.0
+Version: 11.29.0
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
-License-Expression: MIT
+License: MIT
 Project-URL: Homepage, https://www.rocscience.com/software/rs2
 Project-URL: Documentation, https://www.rocscience.com/help/rs2/overview
 Keywords: Rocscience,RS2,Scripting,RocScript,Geotechnical,Finite Element Analysis,FEM,2D
@@ -11,9 +11,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: License.txt
 Requires-Dist: rsmessages==0.0.2
-Dynamic: license-file
 
 ## Introduction 
 This project is a library that can be used to interact with RS2 through python.  
@@ -107,7 +105,8 @@ The following steps can be taken to regenerate the RS2 Scripting Documentation:
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
 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.
+4. To rerun all examples with the command below:
+```python docs/example_code/runAll.py```
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
 

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/README.md

@@ -90,7 +90,8 @@ The following steps can be taken to regenerate the RS2 Scripting Documentation:
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
 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.
+4. To rerun all examples with the command below:
+```python docs/example_code/runAll.py```
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
 

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "RS2Scripting"
-version = "11.27.0"
+version = "11.29.0"
 dependencies = [
   "rsmessages == 0.0.2"
 ]
@@ -19,8 +19,11 @@ classifiers = [
     "Topic :: Scientific/Engineering",
 ]
 keywords = ["Rocscience", "RS2", "Scripting", "RocScript", "Geotechnical", "Finite Element Analysis", "FEM", "2D"]
-license = "MIT"
-license-files = ["License.txt"]
+license = { text = "MIT" }
+
+[tool.setuptools]
+license-files = []
+
 [project.urls]
 Homepage = "https://www.rocscience.com/software/rs2"
 Documentation = "https://www.rocscience.com/help/rs2/overview"

{rs2scripting-11.27.0 → rs2scripting-11.29.0/src/RS2Scripting.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: RS2Scripting
-Version: 11.27.0
+Version: 11.29.0
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
-License-Expression: MIT
+License: MIT
 Project-URL: Homepage, https://www.rocscience.com/software/rs2
 Project-URL: Documentation, https://www.rocscience.com/help/rs2/overview
 Keywords: Rocscience,RS2,Scripting,RocScript,Geotechnical,Finite Element Analysis,FEM,2D
@@ -11,9 +11,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: License.txt
 Requires-Dist: rsmessages==0.0.2
-Dynamic: license-file
 
 ## Introduction 
 This project is a library that can be used to interact with RS2 through python.  
@@ -107,7 +105,8 @@ The following steps can be taken to regenerate the RS2 Scripting Documentation:
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
 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.
+4. To rerun all examples with the command below:
+```python docs/example_code/runAll.py```
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
 

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/src/RS2Scripting.egg-info/SOURCES.txt

@@ -1,4 +1,3 @@
-License.txt
 README.md
 pyproject.toml
 src/RS2Scripting.egg-info/PKG-INFO
@@ -33,8 +32,11 @@ src/rs2/modeler/Model.py
 src/rs2/modeler/RS2Modeler.py
 src/rs2/modeler/__init__.py
 src/rs2/modeler/managed_properties/GanFunctions.py
+src/rs2/modeler/managed_properties/__init__.py
+src/rs2/modeler/managed_properties/material/__init__.py
 src/rs2/modeler/managed_properties/material/strength/GeneralizedHoekBrown.py
 src/rs2/modeler/managed_properties/material/strength/JointedGeneralizedHoekBrown.py
+src/rs2/modeler/managed_properties/material/strength/__init__.py
 src/rs2/modeler/properties/AbsoluteStageFactorGettersInterface.py
 src/rs2/modeler/properties/AbsoluteStageFactorInterface.py
 src/rs2/modeler/properties/CompositeProperty.py
@@ -90,6 +92,7 @@ src/rs2/modeler/properties/material/datum/SimpleDatum.py
 src/rs2/modeler/properties/material/datum/__init__.py
 src/rs2/modeler/properties/material/field_stress/CustomConstant.py
 src/rs2/modeler/properties/material/field_stress/CustomGravity.py
+src/rs2/modeler/properties/material/field_stress/__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

rs2scripting-11.29.0/src/RS2Scripting.egg-info/top_level.txt

@@ -0,0 +1 @@
+rs2

{rs2scripting-11.27.0 → rs2scripting-11.29.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.027"
+		self.compatibleProgramVersion = "11.029"
 		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.27.0 → rs2scripting-11.29.0}/src/rs2/modeler/Model.py

@@ -351,16 +351,6 @@ class Model(BaseModel):
 		|  Renames a discrete function with the given name
 		'''
 		return self._callFunction('renameDiscreteFunction', [oldName, newName])	
-
-	def getGan3Ds(self) -> list[Gan3DFunction]:
-		'''
-		|  Returns a list of all Gan3DFunction objects
-		'''
-		activeGan3DProperties = []
-		gan3DIDList = self._callFunction('getGan3Ds', [], keepReturnValueReference=True)
-		for gan3DObjectID in gan3DIDList:
-			activeGan3DProperties.append(Gan3DFunction(self._client, gan3DObjectID))
-		return activeGan3DProperties
 	
 	def getGan3DFunctions(self, name: str) -> Gan3DFunction:
 		'''
@@ -369,12 +359,6 @@ class Model(BaseModel):
 		objectID = self._callFunction('getGan3DByName', [name], keepReturnValueReference=True)
 		return Gan3DFunction(self._client, objectID)
 	
-	def createGan3DFunction(self, name):
-		'''
-		|  Creates a new Gan3DFunction with the given name
-		'''
-		return self._callFunction('createGan3DFunction', [name])
-
 	def deleteGan3DFunction(self, name):
 		'''
 		|  Deletes a Gan3DFunction with the given name

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/src/rs2/modeler/properties/PropertyEnums.py

@@ -415,3 +415,7 @@ class eGHBEstimationMethod(Enum):
 class eModulusInputMethod(Enum):
 	HB_MODULUS_INPUT_EI = "HB_MODULUS_INPUT_EI"
 	HB_MODULUS_INPUT_MR = "HB_MODULUS_INPUT_MR"
+class eBiotCoefficients(Enum):
+	BIOT_COEFFICIENT_AUTO = "BIOT_COEFFICIENT_AUTO"
+	BIOT_COEFFICIENT_CUSTOM = "BIOT_COEFFICIENT_CUSTOM"
+	BIOT_COEFFICIENT_OFF = "BIOT_COEFFICIENT_OFF"

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/src/rs2/modeler/properties/material/hydraulic/FEAGroundwater/FEAGroundwater.py

@@ -39,13 +39,13 @@ class FEAGroundwater(PropertyProxy):
 	"""
 	Attributes:
 		stageFactorInterface (AbsoluteStageFactorGettersInterface[FEAGroundwaterDefinedStageFactor, FEAGroundwaterStageFactor]): Reference object for modifying stage factor property.
-		Simple (Simple): Reference object for modifying property.
-		Fredlund (Fredlund): Reference object for modifying property.
-		Genuchten (Genuchten): Reference object for modifying property.
-		Brooks (Brooks): Reference object for modifying property.
-		Gardner (Gardner): Reference object for modifying property.
-		Constant (Constant): Reference object for modifying property.
-		UserDefined (UserDefined): Reference object for modifying property.
+		Simple (rs2.modeler.properties.material.hydraulic.FEAGroundwater.Simple.Simple): Reference object for modifying property.
+		Fredlund (rs2.modeler.properties.material.hydraulic.FEAGroundwater.Fredlund.Fredlund): Reference object for modifying property.
+		Genuchten (rs2.modeler.properties.material.hydraulic.FEAGroundwater.Genuchten.Genuchten): Reference object for modifying property.
+		Brooks (rs2.modeler.properties.material.hydraulic.FEAGroundwater.Brooks.Brooks): Reference object for modifying property.
+		Gardner (rs2.modeler.properties.material.hydraulic.FEAGroundwater.Gardner.Gardner): Reference object for modifying property.
+		Constant (rs2.modeler.properties.material.hydraulic.FEAGroundwater.Constant.Constant): Reference object for modifying property.
+		UserDefined (rs2.modeler.properties.material.hydraulic.FEAGroundwater.UserDefined.UserDefined): Reference object for modifying property.
 
 	Examples:
 		:ref:`Hydraulic Property FEAGroundwater Example`

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/src/rs2/modeler/properties/material/hydraulic/Hydraulic.py

@@ -12,11 +12,19 @@ class HydraulicStageFactor(ProxyObject):
 	def __init__(self, client : Client, ID, propertyID):
 		super().__init__(client, ID)
 		self.propertyID = propertyID
+	def getBiotsCoefficientFactor(self) -> float:
+		return self._callFunction("getDoubleFactor", ["MP_BIOT_COEFFICIENT", self.propertyID], proxyArgumentIndices=[1])
+	def getBiotModeFactor(self) -> str:
+		return eBiotCoefficients(self._callFunction("getBiotModeFactor", []))
 	def getMaterialBehaviourFactor(self) -> str:
 		return MaterialBehaviours(self._callFunction("getMaterialBehaviourFactor", []))
 class HydraulicDefinedStageFactor(HydraulicStageFactor):
 	def __init__(self, client : Client, ID, propertyID):
 		super().__init__(client, ID, propertyID)
+	def setBiotsCoefficientFactor(self, value: float):
+		return self._callFunction("setDoubleFactor", ["MP_BIOT_COEFFICIENT", value, self.propertyID], proxyArgumentIndices=[2])
+	def setBiotModeFactor(self, biotMode: eBiotCoefficients):
+		return self._callFunction("setBiotModeFactor", [biotMode.value])
 	def setMaterialBehaviourFactor(self, materialBehavior: MaterialBehaviours):
 		return self._callFunction("setMaterialBehaviourFactor", [materialBehavior.value])
 class Hydraulic(PropertyProxy):
@@ -44,10 +52,14 @@ class Hydraulic(PropertyProxy):
 		return self._getDoubleProperty("MP_FLUID_BULK_MODULUS")
 	def setFluidBulkModulus(self, value: float):
 		return self._setDoubleProperty("MP_FLUID_BULK_MODULUS", value)
-	def getUseBiotsCoefficientForCalculatingEffectiveStress(self) -> bool:
-		return self._getBoolProperty("MP_USE_ALPHA_BIOT")
-	def setUseBiotsCoefficientForCalculatingEffectiveStress(self, value: bool):
-		return self._setBoolProperty("MP_USE_ALPHA_BIOT", value)
+	def getBiotsCoefficientCalculationMethod(self) -> eBiotCoefficients:
+		return eBiotCoefficients(self._getEnumEBiotCoefficientsProperty("MP_BIOT_MODE"))
+	def setBiotsCoefficientCalculationMethod(self, value: eBiotCoefficients):
+		return self._setEnumEBiotCoefficientsProperty("MP_BIOT_MODE", value)
+	def getBiotsCoefficient(self) -> float:
+		return self._getDoubleProperty("MP_BIOT_COEFFICIENT")
+	def setBiotsCoefficient(self, value: float):
+		return self._setDoubleProperty("MP_BIOT_COEFFICIENT", value)
 	def getAccountForWaterContentInCompressibility(self) -> bool:
 		return self._getBoolProperty("MP_USE_WC_IN_COMP_COUPLED")
 	def setAccountForWaterContentInCompressibility(self, value: bool):

{rs2scripting-11.27.0 → rs2scripting-11.29.0}/src/rs2/modeler/properties/propertyProxy.py

@@ -129,6 +129,10 @@ class PropertyProxy(ProxyObject):
 		return self._callFunction("getEnumEMaterialBehavioursProperty", [propertyName])
 	def _setEnumEMaterialBehavioursProperty(self, propertyName: str, value):
 		return self._callFunction("setEnumEMaterialBehavioursProperty", [propertyName, value.value, self.documentProxyID], proxyArgumentIndices=[2])
+	def _getEnumEBiotCoefficientsProperty(self, propertyName: str):
+		return self._callFunction("getEnumEBiotCoefficientsProperty", [propertyName])
+	def _setEnumEBiotCoefficientsProperty(self, propertyName: str, value):
+		return self._callFunction("setEnumEBiotCoefficientsProperty", [propertyName, value.value, self.documentProxyID], proxyArgumentIndices=[2])
 	def _getEnumEGroundWaterModesProperty(self, propertyName: str):
 		return self._callFunction("getEnumEGroundWaterModesProperty", [propertyName])
 	def _setEnumEGroundWaterModesProperty(self, propertyName: str, value):

rs2scripting-11.27.0/License.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2024 Rocscience Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

rs2scripting-11.27.0/src/RS2Scripting.egg-info/top_level.txt

@@ -1,2 +0,0 @@
-rs2
-rs2_mcp_server