RSWall Scripting Reference Manual

Version: 1.006

Prerequisites

Before you begin, ensure you have the RSWall application installed on Windows. Python scripting communicates with a running RSWall instance over gRPC (default port 60067).

Python Environment

There are two methods to run a script, which differ in the Python environment used:

1. Running in RocScript Editor

   • Opens from RSWall (Scripting → RocScript).

   • Suitable for interactive editing and running scripts against a live RSWall session.

2. Running in your own Python environment

   • Requires installing the RSWallScripting Python package (see below).

   • Suitable for automation, CI, and advanced workflows.

Install RSWall Python API Library

pip installation:

pip install RSWallScripting

If you are not using the latest release of RSWall, pin a library version that matches your product release. For example:

pip install "RSWallScripting==1.006"

Table of Contents

• Getting Started
  • Start RSWall with the scripting server
  • Connect and open a project
  • Default port
• rswall package
  • RSWallModeler
  • ApplicationManager
  • Wall
  • Material
  • GravityWallProfile
  • CantileverWallProfile
  • AbutmentWallProfile
  • MSEWallUnit
  • GabionWallUnit
  • MSESectionProfile
  • GabionSectionProfile
  • Reinforcement
  • LineLoad
  • UniformLoad
  • PointLoad
  • WizardWallResult
  • WizardSegment
  • SoilTopography
  • wizard_plan_points
  • wizard_requirements
• Python Script Examples
  • Model Script Example
  • Modeler Script Example
  • Materials Example
  • Gravity Wall Profile Example
  • Loads Example
  • Soil Assignment and Topography Example
  • Groundwater Example
  • MSE Wall Unit and Section Profile Example
  • Gabion Wall Unit and Section Profile Example
  • Reinforcement and Layout Example
  • Leveling Pad and Base Strength Example
  • Wall Geometry Example
  • Analysis Example
  • Wall Wizard Example