Scripting Overview
RocSlope2 Scripting is a powerful API tool to automate modelling workflows and enhance analysis capabilities of RocSlope2.
By leveraging RocSlope2 Scripting, users can access a wide range of benefits, including:
- Automating RocSlope2 modelling workflows by streamlining repetitive tasks for users of all levels such as inputs, analysis, and outputs
- Customizing scripts for projects of specific needs with the API library as well as other popular Python libraries to boost efficiency and flexibility
Methodology
Built upon the standard Python programming language, RocSlope2 Scripting provides seamless interaction with the software platform. The RocSlope2 Python API Library contains comprehensive functions and modules to integrate with RocSlope2 commands.
Users can combine the RocSlope2 Python API Library with popular Python libraries such as NumPy, Scikit-learn, TensorFlow, Pandas and Matplotlib to extend the level of data science and machine learning for engineering analysis.
RocSlope2 Python Environment
The RocScript Editor serves as the pre-configured Python editor. The RocSlope2 Python API Library is included with the RocScript installation package (see Installation section below).
Besides RocScript, users can alternatively use their own python environment. In this case, the RocSlope2 Python API Library needs to be downloaded to their preferred code editor. See the Getting Started with RocSlope2 Python Scripting tutorial for detailed instructions on how to set this up.
Main Functions
The key components of the current RocSlope2 Scripting functions are listed below. For more detail about RocSlope2 Scripting functions, see the RocSlope2 Python Reference Manual.
- Open/Close RocSlope2 Application
- New/Open/Save/Save As/Close Project
- Import Legacy Files (SWedge, RocPlane, RocTopple)
- Export Image
- Compute
- Set/Get Project Settings (Units, Analysis, Statistics, Design Standard, Wedge, Toppling)
- Set/Get Slope Geometry (Slope Face, Upper Face, Tension Crack)
- Set/Get Slope Properties
- Add/Delete/Edit/Get Joint Sets
- Add/Delete/Edit/Get Individual Joints
- Add/Delete/Edit/Get Joint Properties (Strength, Water Parameters)
- Import Joint Sets from DIPS
- Add/Delete/Edit/Get Support:
- Bolt Properties
- Bolt Patterns
- Spot Bolts
- User Defined Support
- Shotcrete
- Set/Get Loading:
- Pressure Loading
- Point Loads
- Seismic Loading
- Point of Force Application
- Set/Get Statistical Distributions
- Set/Get Scale Wedge/Planar Blocks
- Get Analysis Results (Wedge, Planar, Toppling)
Scripting Menu
Navigate to the Scripting ribbon to start using RocSlope2 Scripting. The menu allows you to:
- Manage Scripting Server
- Launch RocScript Editor
- Manage Python Environment
- RocScript Editor Command Prompt - Open Scripting Reference Manual
For more details see the Scripting Tools topic.
Getting Started
To begin with RocSlope2 Scripting, please see the Getting Started with RocSlope2 Python Scripting tutorial.
Installation
If you do not have the RocScript Editor installed on your computer, you can download and install the program in one of two ways:
- Select Scripting > Scripting Options > Launch RocScript Editor . If the program is not installed on your computer, you will be prompted to open the RocScript Update History page, where you can download the latest version of the tool.
- Go to the Program Downloads page and download RocScript from the tools table.
Tutorials
The scripting tutorials demonstrate practical applications of the API tool, showcase the API function scripts, and exhibit potential performance for project-specific analyses. The Python script, initial and final model files are provided for each tutorial.
Community Guide
Review the RocSlope2 Python Reference Manual for RocSlope2 Scripting functions and using the API calls.
If you have questions or concerns about the library, you can reach out to us through Get Support.