Scripting Overview
RSWall Scripting is a powerful API tool to automate modelling workflows and enhance analysis capabilities of RSWall.
By leveraging RSWall Scripting, users can access a wide range of benefits, including:
- Automate RSWall modelling workflows by streamlining repetitive tasks for users of all levels
- Develop project-specific parametric analyses and other higher-level studies by integrating the API with RSWall
- Manage model inputs and computed results, including soils, wall types, loads, reinforcement, geometry, factors of safety, and result symbols
- Customize scripts for project-specific needs by combining the RSWall Python API with popular Python libraries such as NumPy, Pandas, and Matplotlib.
Methodology
RSWall Scripting is built on the standard Python programming language and provides seamless interaction with the RSWall software platform. The RSWall Python API Library (rswall) provides functions and modules for integrating Python with RSWall through its local scripting server. Users can work with the RocScript Editor or their own Python environment to connect to a running RSWall application.
Users can combine the RSWall 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.
RSWall Python Environment
The RocScript Editor is the pre-configured Python editor. Use Help > Scripting > Open Script Editor
Besides RocScript, users can alternatively use their own python environment. In this case, the RSWall Python API Library needs to be downloaded to their preferred code editor.
Main Functions
Key capabilities in the current RSWall Python API are listed below. For class and method detail, see the RSWall Python Reference Manual.
- Open, close, save, and manage RSWall projects
- Read project units and summary information
- Create and modify soils, wall types, and section profiles
- Manage MSE/SRW and Gabion wall units and reinforcement
- Create and assign loads, soils, and topography
- Create and edit walls and segments
- Generate multi-segment walls using the Wall Wizard
Scripting Menu
Use the Scripting group on the Help ribbon:
- Manage Scripting Server
- Open Scripting Editor
- Manage Python Environment
- Reference Manual
Getting Started
To begin with RSWall Scripting, please see the RSWall Scripting tutorials.
Installation
If RocScript Editor is not installed:
- Choose Help → Open Scripting Editor. If RocScript is missing, you are directed to download it (RocScript Update History).
- Or download RocScript from the Program Downloads tools table.
Tutorials
Scripting tutorials demonstrate practical applications of the API tool, showcase the API function scripts, and exhibit potential performance for project-specific analyses.
Community Guide
Use the RSWall Python Reference Manual for objects, methods, and examples.
If you have questions about the library, contact Get Support.