RocSlope2 Scripting Reference Manual

Version: 0.1.0

Prerequisites

Before you begin, ensure you have the RocSlope2 program installed.

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 RocSlope2 and includes the RocSlope2 Python API library

   • For all-level users

2. Running on your own Python environment

   • Requires downloading the RocSlope2 Python API library

   • For advanced users

Install RocSlope2 Python API Library

pip installation

pip install RocSlope2Scripting

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

pip install "RocSlope2Scripting==0.1.0"

Table of Contents

Contents:

• RocSlope2 Package
  • rocslope2.analysisResults package
  • rocslope2.boltPattern package
  • rocslope2.boltProperties package
  • rocslope2.importFromDips package
  • rocslope2.individualJoint package
  • rocslope2.jointProperties package
  • rocslope2.jointSet package
  • rocslope2.loading package
  • rocslope2.pointLoad package
  • rocslope2.pointOfForceApplication package
  • rocslope2.projectSettings package
  • rocslope2.scaleBlock package
  • rocslope2.seismicLoading package
  • rocslope2.shotcrete package
  • rocslope2.slopeGeometry package
  • rocslope2.slopeProperties package
  • rocslope2.spotBolt package
  • rocslope2.ColorPicker module
  • rocslope2.Model module
  • rocslope2.PropertyEnums module
  • rocslope2.RocSlope2Modeler module
  • rocslope2.StatsDistribution module
• Python Script Examples
  • Model Script Example
  • Modeler Script Example
  • Project Settings Script Example
  • Slope Geometry Script Example
  • Slope Properties Script Example
  • Joint Set Script Example
  • Individual Joint Script Example
  • Joint Properties Script Example
  • Bolt Properties Script Example
  • Bolt Pattern Script Example
  • Spot Bolt Script Example
  • Shotcrete Script Example
  • Pressure Loading Script Example
  • Point Load Script Example
  • Seismic Loading Script Example
  • Point of Force Application Script Example
  • Scale Block Script Example
  • Import From Dips Script Example
  • Analysis Results Script Example
  • Statistical Distribution Script Example