RSPileModeler#

class RSPileModeler(port=60054)#

Bases: object

logger = <Logger Rocscience.RSPile.RSPileModeler (WARNING)>#

openFile(fileName: str) → RSPileModel#

Examples: Code Snippet: Modeler Scripting Functionality

classmethod startApplication(port: int, overridePathToExecutable: str = None, timeout: float = 30) → None#

Starts RSPile, with the option to override the default executable path.

Parameters:

• port – int The port number to bind the server to. Must be a port number between 49152 and 65535.

• overridePathToExecutable – str, optional An optional path to override the default RSPile executable. If not provided, the latest installation of RSPile will be used.

• timeout – float, optional The maximum time to wait for the server to start and bind to the specified port, by default 30 seconds.

Returns:

None

Note

The logger is configured under the Rocscience.RSPile namespace.

Examples: Code Snippet: Modeler Scripting Functionality

closeApplication(timeout=30) → None#

Closes the application.

Parameters:

timeout – float, optional The maximum time to wait for the application to close and release the port, by default 30 seconds.

Returns:

None

Raises:

TimeoutError – The application did not close within the given timeout time.

Examples: Code Snippet: Modeler Scripting Functionality