Scripting Overview

The Slide2 Scripting is a powerful API tool to automate modelling workflows and enhance analysis capabilities of Slide2.

By leveraging Slide2 Scripting, users can access to a wide range of benefits, including:

• Automate Slide2 modeling workflows by streamlining repetitive tasks for users of all levels
• Develop project-specific statistical analyses, parametric analyses, and other higher-level studies by integrating the API tool with the software
• Manage database for both model input parameters and computed results by utilizing the import/export to csv or equivalent features
• 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, Slide2 Scripting serves seamless interaction with the software platform. The Slide2 Python API Library contains comprehensive functions and modules to integrate with Slide2.

Users can combine the Slide2 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.

Slide2 Python Environment

The RocScript Editor serves as the pre-configured Python editor. The Slide2 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 Slide2 Python API Library needs to be downloaded to their preferred code editor. 

Main Functions

The key components of the current Slide2 Scripting functions are listed below. For more detail about Slide2 Scripting functions, see the Slide2 Python Reference Manual.

• Open/Close Slide2 Application
• Open/Save/Close Model
• Modify Properties
• Compute Model
• Obtain tabular results data
• Query results data

Scripting Menu

Navigate to the Scripting menu to start using Slide2 Scripting. The menu allows you to:

• Manage Scripting Server
• Launch RocScript Editor
• Manage Python Environment
• Open Scripting Reference Manual

For more details see the Scripting Tools topic.

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 > Scripting Options > Launch RocScript Editor in the Slide2 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.

Community Guide

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

If you have questions or concerns about the library, you can reach out to us through Get Support.