Scripting Overview

RSSeismic Scripting is a powerful API tool to automate workflows and enhance analysis capabilities of RSSeismic.

RSSeismic Scripting allows users to perform different actions through Python scripts that access and control the program without the direct GUI interactions. This capability allows users to:

• Automate RSSeismic workflows, specifically the creation of projects, building profiles, assigning soil properties, generating dynamic curves, among others.
• Batch run, and process multiple projects or profiles, as well as streamlining the postprocessing of the results
• 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, RSSeismic Scripting provides interaction with the software platform. The RSSesimic Python API Library contains comprehensive functions and modules to integrate with RSSeismic.

Users can combine the RSSeismic Python API Library with popular Python libraries to expand the software capabilities particularly for large-scale analyses.

RSSeismic Python Environment

The RocScript Editor serves as the pre-configured Python editor. The RSSeismic 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 RSSeismic 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 RSSesimic Scripting functions are listed below. For more detail about RSSeismic Scripting functions, see the RSSeismic Python Reference Manual.

• Open/Close RSSeismic Application 
• Open/Save/Close Project (Model) 
• Create New Project 
• Batch Compute (multiple project files) 
• Control Project Settings:
  • Units o Analysis Mode 
  • Default Soil Model and Hysteretic Formulation
  • Solver Options
  • Input Motion Configuration 
  • Equivalent Linear and Complementary Analysis Options 
• Control Automatic Profile Generation Settings
• Query and Control Layer Structure
• Query and Modify Mean Profile 
• Generate and Modify Realizations
• Query and Modify Soil Layer and Bedrock Layer Properties
• Query and Control Reference Curves and Curve Fitting 
• Register Ground Motion Directories and Refresh Motion Lists
• Select Motions or Motion Pairs for Analysis 
• Compute Project 
• Query Results Data by Profile, Motion, and Layer Selection 

Please stay tuned with Rocscience for more integrated and powerful functions.

Scripting Menu

Navigate to the Scripting menu to start using RSSeismc 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 RSSeismic Scripting, please see Getting Started with RSSeismic Python Scripting.

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 > Launch RocScript Editor in the RSSeismic 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.

• Getting Started with RSSeismic Python Scripting
• 1 -Building a Single Profile and Running an Analysis
• 2 - Building Multiple Projects and Running Batch Processing

Community Guide

Review the RSSeismic Python Reference Manual for RSSeismic Scripting functions and using the API calls.