Scripting Overview
Dips Scripting is a powerful API tool to automate modelling workflows and enhance analysis capabilities of Dips.
By leveraging Dips Scripting, users can access a wide range of benefits, including:
- Automating Dips modelling workflows by streamlining repetitive tasks for users of all levels such as inputs, analysis, and outputs
- Customizing 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, Dips Scripting provides seamless interaction with the software platform. The Dips Python API Library contains comprehensive functions and modules to integrate with Dips commands.
Users can combine the Dips 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.
Dips Python Environment
The RocScript Editor serves as the pre-configured Python editor. The Dips 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 Dips Python API Library needs to be downloaded to their preferred code editor. See the Getting Started with Dips Python Scripting tutorial for detailed instructions on how to set this up.
Main Functions
The key components of the current Dips Scripting functions are listed below. For more detail about Dips Scripting functions, see the Dips Python Reference Manual.
- Open/Close Dips Application
- Open/Save/Close Project
- Open/Close
Views (Stereonet 2D, Stereonet 3D, Rosette, Joint Spacing, Joint
Frequency, RQD Analysis, Qualitative/Quantitative Analysis, Kinematic
Sensitivity, Histogram, Cumulative, Scatter)
- Set/Get View Settings (e.g., Visibility, Properties, Chart Options)
- Set/Get Display Options
- Set/Get Weighting Options
- Set/Get Reporting Convention of Units and Orientations
- Add/Delete/Edit/Get Orientation Data
- Add/Delete/Edit/Get Data Filters
- Add/Delete/Set/Get Active Data Filter
- Create Rotated Pole Data
- Create Synthetic Pole Data
- Create Filtered Pole Data
- Get Processed Pole Data
- Get Set Statistics
- Get Fold Statistics
- Get Intersections
- Set Stereonet Settings:
- Projection Mode/Hemisphere
- Vector Mode
- Pole Mode
- Symbolic Settings
- Intersection Type
- Contour Options
- Contour Data
- Kinematic Analysis Options
- Add/Delete/Edit Stereonet Entities:
- User Planes
- Sets
- Folds
- Global Best Fit
- Global Mean
- Tools
Scripting Menu
Navigate to the Scripting ribbon to start using Dips 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 Dips Scripting, please see the Getting Started with Dips Python Scripting tutorial.
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. If the program is not installed on your computer, you will be automatically redirected 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.
Community Guide
Review the Dips Python Reference Manual for Dips 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.