RS3 Scripting Reference Manual

Version: 4.042.0

Prerequisites

Before you begin, ensure you have the RS3 program installed. You must have at minimum Version 4.042 in order to use this feature.

Python Environment

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

1. Running on RocScript Editor

   • Comes pre-installed with RS3 and includes the RS3 Python API library

   • For all-level users

2. Running on your own Python environment

   • Requires downloading the RS3 Python API library

   • For advanced users

Install RS3 Python API Library

pip installation

pip install RS3Scripting

If you are not using the latest release of RS3, you need to specify a library version that matches your RS3 version. For example:

pip install "RS3Scripting==4.042.0"

Table of Contents

Contents:

• rs3 package
  • rs3.loadings package
  • rs3.mesh package
  • rs3.projectSettings package
  • rs3.properties package
  • rs3.results package
  • rs3.ApplicationManager module
  • rs3.ColorPicker module
  • rs3.CommonEnums module
  • rs3.Compute module
  • rs3.ExternalVolume module
  • rs3.Geometry module
  • rs3.Model module
  • rs3.ModelEnums module
  • rs3.RS3Modeler module
  • rs3.Restraints module
  • rs3.Selection module
• Python Script Examples
  • Model Script Examples
  • Open and Close Model Script Example
  • Project Settings Script Examples
  • External Volume and Selection Script Examples
  • Field Stress Script Examples
  • Restraints Script Examples
  • Mesh Script Example
  • Compute Script Examples
  • Material Initial Conditions Script Examples
  • Material Constitutive Models Script Examples
  • Material Hydraulic Script Examples
  • Material Datum Script Examples
  • Material Stage Factors Script Examples
  • Beam Script Examples
  • Bolt Script Examples
  • Joint Script Examples
  • Liner Script Examples
  • Pile Script Examples
  • Composite Liner Script Examples
  • Water By Location Script Examples
  • Water Grid Script Examples
  • Solid Result Script Example
  • Beam Result Script Example
  • Bolt Result Script Example
  • Joint Result Script Example
  • Pile Result Script Example
  • Composite Liner Result Script Example