Scripting Overview
The RSPile Scripting is a powerful API tool to automate modelling workflows and enhance analysis capabilities of RSPile.
By leveraging RSPile Scripting, users can access to a wide range of benefits, including:
- Automate RSPile modeling workflows by streamlining repetitive tasks for users of all levels
- Develop project-specific statistical analyses, parametric analyses, and other higher-level studies by integrating the API tool with the software
- Manage database for both model input parameters and computed results by utilizing the import/export to csv or equivalent features
- Customize 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, RSPile Scripting serves seamless interaction with the software platform. The RSPile Python API Library contains comprehensive functions and modules to integrate with RSPile.
Users can combine the RSPile 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.
RSPile Python Environment
The RocScript Editor serves as the pre-configured Python editor. The RSPile 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 RSPile Python API Library needs to be downloaded to their preferred code editor. See the Getting Started tutorial for detailed instructions on how to set this up.
Main Functions
The key components of the current RSPile Scripting functions are listed below. For more detail about RSPile Scripting functions, see the RSPile Python Reference Manual.
- Open/Close RSPile Application
- Open/Save/Close Model
- Modify Soil properties
- Modify Pile Sections
- Modify Pile Types
- Compute Model
- Obtain tabular results data
- Query results data for max/min values for specific piles or across all piles.
General
- Open/Save/Close model
- Import/Export csv
Scripting Menu
Navigate to the Scripting menu to start using RSPile 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 RSPile Scripting, please see the Getting Started 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 in the RSPile menu. If the program is not installed on your computer, you will automatically be directed to 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 RSPile Python Reference Manual for RSPile 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.