Bentley Communities
Bentley Communities
  • Site
  • User
  • Site
  • Search
  • User
  • Welcome
  • Products
  • Support
  • About
  • More
  • Cancel
GeoStudio | PLAXIS
  • Product Communities
GeoStudio | PLAXIS
GeoStudio | PLAXIS Wiki API / Python scripting - PLAXIS
    • Sign In
    • -Geotechnical Analysis Wiki
      • +GeoStudio
      • -PLAXIS
        • +Software and License - PLAXIS
        • +Documentation - PLAXIS
        • -API / Python scripting - PLAXIS
          • Access to Staged Construction settings using Python
          • Adding functionality to PLAXIS Calculation Manager: pre- and post-processing
          • Automatic line cross-section chart generation using Python
          • Automatically generated cross-sections of embankments
          • Changing the material colour using Python scripting
          • Combined plate results in one chart using Python
          • Create custom connection with selection API
          • Export and format plots from PLAXIS Output using Python
          • How to create a tunnel using Python
          • How to get a load - displacement curve using Scripting interface
          • How to install additional Python modules in PLAXIS
          • How to open and close a PLAXIS project with Python
          • How to retrieve results from PLAXIS Output by the node number
          • Identify Python commands from Plaxis command line
          • Material lists in PLAXIS – Python
          • Material Property changes for Python scripting
          • Optimize excavation calculation time for wall horizontal displacement criteria
          • Output scripting example: create curve data
          • Output scripting example: get anchor force
          • Output scripting example: get heave of excavation bottom
          • Output scripting example: get maximum bending moment
          • Polycurves to Polygons in PLAXIS 2D using Python
          • Receive instant notifications for finished calculations on your phone
          • Remove invalid custom connections for PLAXIS 3D
          • Retrieve coordinates of a Polygon in PLAXIS 2D using Python
          • Retrieving soil layer info from boreholes using Python
          • Scripting reference and how to use it
          • Selection API for PLAXIS Input
          • Soil layer material assignment using Python
          • Support capacity evaluation of a tunnel lining in PLAXIS 2D
          • Tunnel advancement script for PLAXIS 3D
          • User defined Python script (3D): Extract displacements by coordinates
        • +Known issues - PLAXIS
        • +Models - PLAXIS
        • +Tips and Tricks
        • +Publications
        • +Videos - PLAXIS
      • +PLAXIS Monopile Designer
      • +PLAXIS LE
      • +SOILVISION
      • +Geotechnical SELECT Entitlements [GSE]
      • +Subscription Entitlement Service

     
     Questions about this article, topic, or product? Click here. 

    API / Python scripting - PLAXIS

    This section contains examples and background information on the use of the PLAXIS Remote Scripting server API and the use of the Python wrapper.

    Using PLAXIS Remote scripting with the Python wrapper
    • wrapper
    • boilerplate
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Access to Staged Construction settings using Python
    The staged construction settings and values for any Intrinsic properties of all UserFeatures can be retrieved and set using these Python scripts.
    • staged construction
    • phase
    • activation
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Adding functionality to PLAXIS Calculation Manager: pre- and post-processing
    When using the Calculation manager tool, it is possible to include one pre-processing and/or one post-processing Python script.
    • output
    • calculation manager
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Automatic line cross-section chart generation using Python
    Having trouble making cross sections for PLAXIS results using the Python wrapper? Find a working solution with an example in this article!
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Automatically generated cross-sections of embankments
    A Python script was developed to create multiple cross-sections of an embankment at different locations making the design process more effective.
    • PLAXIS 2D
    • tags:
    Changing the material colour using Python scripting
    In this example, we will show how to change a soil material colour in PLAXIS 2D and PLAXIS 3D using a working Python script example.
    • rgb
    • material
    • colour
    • color
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Combined plate results in one chart using Python
    We defined a Python script combining forces and displacements for a single wall into one plot and table for easy extraction of combined results. The page includes a fully working Python script for PLAXIS 2D 2017 you can run directly from the program without installing or programming!
    • tool
    • table
    • pyapp
    • plot
    • matplotlib
    • deflection
    • bending moment
    • bending
    • app
    • PLAXIS 2D
    • tags:
    Command line reference
    • reference
    • objects
    • object name
    • object
    • documentation
    • commands
    • command line
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Create custom connection with selection API
    • selection
    • pyapp
    • input
    • PLAXIS 3D
    • tags:
    Export and format plots from PLAXIS Output using Python
    PLAXIS Output offers the possibility of using Python scripting to configure the plot settings in order to export a plot to a file for post-processing.
    • visualisation
    • plot
    • output
    • export
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    How to create a tunnel using Python
    In this article, it is explained how to use the Remote scripting feature (Python commands) to create a tunnel using the PLAXIS tunnel designer.
    • tunnel designer
    • tunnel
    • PLAXIS 2D
    • NATM tunnel
    • tags:
    How to get a load - displacement curve using Scripting interface
    • load-displacement
    • load
    • curve
    • PLAXIS 2D
    • tags:
    How to install additional Python modules in PLAXIS
    The article explains the available options on how to install and use any Python modules with the PLAXIS scripting environment.
    • module
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    How to open and close a PLAXIS project with Python
    The following article explains how to open and close any PLAXIS project using Python when using the PLAXIS scripting environment.
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    How to retrieve results from PLAXIS Output by the node number
    A simple Python example on how to retrieve results from the PLAXIS 2D Output program by providing the node number.
    • output
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Identify Python commands from Plaxis command line
    Since PLAXIS CONNECT Edition V20, extensive documentation is available regarding the Remote Scripting functionality. This can be found under Help > Scripting reference menu. The first step to identify the command syntax when using the Python scripting functionality is to understand the Plaxis native command.
    • reference
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Material Property changes for Python scripting
    The Material object data structure has been updated to be more flexible for future developments. This page list the changes between PLAXIS V21 and V22
    • materials
    • changes
    • tags:
    Material lists in PLAXIS - Python
    To get a list of just soil or plate material using Python, we can use a simple line to retrieve these. Here we show you how to easily do this.
    • materials
    • material set
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Optimize excavation calculation time for wall horizontal displacement criteria
    A Python script is provided to stop the calculation at an intermediate phase if the horizontal displacement is larger than a limitation in excavations
    • plate
    • excavation
    • deformations
    • PLAXIS 2D
    • tags:
    Output scripting example: create curve data
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Output scripting example: get anchor force
    • output
    • force
    • anchor
    • PLAXIS 2D
    • tags:
    Output scripting example: get heave of excavation bottom
    • output
    • PLAXIS 2D
    • tags:
    Output scripting example: get maximum bending moment
    • results
    • output
    • PLAXIS 2D
    • tags:
    PLAXIS Soil model numbers in command line
    For PLAXIS 2D or 3D you can define a soil/rock material with a specific soil model directly via the command line or via remote scripting.
    • user defined soil model
    • udsm
    • soil model
    • soil
    • rock
    • command line
    • command
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Polycurves to Polygons in PLAXIS 2D using Python
    Sometimes you import a geometry into PLAXIS 2D via e.g. a DXF file, but the import does not generate soil polygons, but polycurves (just the outlines). This Python script fixes it.
    • script
    • pyapp
    • polygon
    • polycurve
    • import
    • dxf
    • PLAXIS 2D
    • tags:
    Receive instant notifications for finished calculations on your phone
    • push
    • notifications
    • mobile
    • iphone
    • ios
    • android
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Remove invalid custom connections for PLAXIS 3D
    With the PLAXIS Remote scripting API, it is possible to automate the process of handling any invalid custom connections present in a project.
    • connection
    • PLAXIS 3D
    • tags:
    Retrieve coordinates of a Polygon in PLAXIS 2D using Python
    In PLAXIS 2D, you may want to know all the coordinates of a polygon in order to use it in your Python/scripting environment. This page shows a Python snippet to quickly retrieve this info.
    • polygon
    • points
    • geometry
    • PLAXIS 2D
    • tags:
    Retrieving soil layer info from boreholes using Python
    In each borehole, soil layer information is stored: top, bottom and thickness. The attached Python script reads this data and returns it to be used in your script!
    • stratigraphy
    • soil layers
    • soil layer
    • borehole
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Scripting reference and how to use it
    Since PLAXIS CONNECT Edition V20, extensive documentation is available regarding the Remote Scripting functionality. This can be found under Help > Scripting reference menu. The documentation is based on Jupyter notebooks and requires the activation of the Remote scripting server.
    • notebook
    • jupyter
    • commands
    • command_reference
    • command
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Selection API for PLAXIS Input
    With Python scripting, it is now possible to take advantage of the interactive selection of objects and pass them to the scripting layer for further usage. This can be achieved using the selection API.
    • selection
    • input
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Soil layer material assignment using Python
    This Python scripting example will teach you how to automatically assign soil materials to the borehole soil layers in your PLAXIS model.
    • soil layers
    • soil layer
    • materials
    • PLAXIS 3D
    • PLAXIS 2D
    • tags:
    Support capacity evaluation of a tunnel lining in PLAXIS 2D
    An example is provided for the Python automation of defining composite section plate properties and evaluating tunnel liner capacity with PLAXIS 2D.
    • tunnel lining
    • tunnel designer
    • tunnel
    • plate
    • PLAXIS 2D
    • tags:
    Tunnel advancement script for PLAXIS 3D
    Advancing tunnels in PLAXIS 3D may need many calculation phases to model the full sequence and can be tedious to do. Using automation (and Python) this can all be done with a single action.
    • tunnel designer
    • tunnel
    • tool
    • sequencing
    • pyapp
    • app
    • PLAXIS 3D
    • NATM tunnel
    • tags:
    User defined Python script (3D): Extract displacements by coordinates
    • user-defined
    • udpy
    • results
    • output
    • deformations
    • deformation
    • PLAXIS 3D
    • tags:
    • PLAXIS 3D
    • python
    • API
    • Automation
    • Scripting
    • PLAXIS 2D
    • Share
    • History
    • More
    • Cancel
    • Micha van der Sloot Created by Bentley Colleague Micha van der Sloot
    • When: Thu, Mar 5 2020 8:23 AM
    • Stefanos Papavasileiou Last revision by Bentley Colleague Stefanos Papavasileiou
    • When: Mon, Oct 31 2022 10:17 AM
    • Revisions: 14
    • Comments: 0
    Recommended
    Related
    Communities
    • Home
    • Getting Started
    • Community Central
    • Products
    • Support
    • Secure File Upload
    • Feedback
    Support and Services
    • Home
    • Product Support
    • Downloads
    • Subscription Services Portal
    Training and Learning
    • Home
    • About Bentley Institute
    • My Learning History
    • Reference Books
    Social Media
    •    LinkedIn
    •    Facebook
    •    Twitter
    •    YouTube
    •    RSS Feed
    •    Email

    © 2023 Bentley Systems, Incorporated  |  Contact Us  |  Privacy |  Terms of Use  |  Cookies