Bentley Communities
Bentley Communities
  • Site
  • User
  • Site
  • Search
  • User
  • Welcome
  • Products
  • Support
  • About
  • More
  • Cancel
PLAXIS | SOILVISION
  • Product Communities
  • More
PLAXIS | SOILVISION
PLAXIS | SOILVISION Wiki API / Python scripting - PLAXIS
    • Sign in
    • +Working from home with PLAXIS
    • +Working from home with PLAXIS LE
    • -PLAXIS Wiki
      • +Geotechnical SELECT Entitlements [GSE]
      • -PLAXIS
        • PLAXIS CONNECT Edition and legacy versions
        • +License - PLAXIS
        • +PLAXIS Software downloads
        • +Release Notes PLAXIS 2D and PLAXIS 3D
        • +Manuals - PLAXIS
        • -API / Python scripting - PLAXIS
          • How to install additional Python modules in PLAXIS
          • Access to Staged Construction settings using Python
          • Automatic line cross-section chart generation using Python
          • Changing the material colour using Python scripting
          • Combined plate results in one chart using Python
          • Create custom connection with selection API
          • How to create a tunnel using Python
          • How to get a load - displacement curve using Scripting interface
          • Identify Python commands from Plaxis command line
          • Material lists in PLAXIS – Python
          • 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
          • 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
          • Tunnel advancement script for PLAXIS 3D
          • User defined Python script (3D): Extract displacements by coordinates
          • Adding functionality to PLAXIS Calculation Manager: pre- and post-processing
          • Remove invalid custom connections for PLAXIS 3D
          • Automatically generated cross-sections of embankments
        • +Downloads - PLAXIS
        • +Known issues - PLAXIS
        • +Models - PLAXIS
        • +Publications
        • +Tips and Tricks
        • +Tutorials - PLAXIS
        • +Verifications - PLAXIS
        • +Videos - PLAXIS
      • +PLAXIS LE
      • +PLAXIS Monopile Designer
      • +SOILVISION
      • +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
    Tagged: API, PLAXIS 2D, PLAXIS 3D, boilerplate, wrapper
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, activation, automation, phase, staged construction
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation, calculation manager, output
    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!

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation, color, colour, material, rgb
    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!

    Tagged: API, PLAXIS 2D, app, automation, bending, bending moment, deflection, matplotlib, plot, pyapp, table, tool
    Command line reference
    Tagged: PLAXIS 2D, PLAXIS 3D, command line, commands, documentation, object, object name, objects, reference
    Create custom connection with selection API
    Tagged: API, PLAXIS 3D, automation, input, pyapp, selection
    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.

    Tagged: API, NATM tunnel, PLAXIS 2D, tunnel, tunnel designer
    How to get a load - displacement curve using Scripting interface
    Tagged: API, PLAXIS 2D, curve, load, load-displacement
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, module
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, reference
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation, material set, materials
    Output scripting example: create curve data
    Tagged: API, PLAXIS 2D, PLAXIS 3D
    Output scripting example: get anchor force
    Tagged: API, PLAXIS 2D, anchor, automation, force, output
    Output scripting example: get heave of excavation bottom
    Tagged: API, PLAXIS 2D, automation, output
    Output scripting example: get maximum bending moment
    Tagged: API, PLAXIS 2D, automation, output, results
    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.

    Tagged: PLAXIS 2D, dxf, import, polycurve, polygon, pyapp, script
    Receive instant notifications for finished calculations on your phone
    Tagged: API, PLAXIS 2D, PLAXIS 3D, android, ios, iphone, mobile, notifications, push
    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.

    Tagged: API, PLAXIS 3D, automation, connection
    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.

    Tagged: API, PLAXIS 2D, automation, geometry, points, polygon
    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!

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation, borehole, soil layer, soil layers, stratigraphy
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, command, command_reference, commands, jupyter, notebook
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation, input, selection
    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.

    Tagged: API, PLAXIS 2D, PLAXIS 3D, automation, materials, soil layer, soil layers
    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.

    Tagged: API, NATM tunnel, PLAXIS 3D, app, pyapp, sequencing, tool, tunnel, tunnel designer
    User defined Python script (3D): Extract displacements by coordinates
    Tagged: API, PLAXIS 3D, deformation, deformations, output, results, udpy, user-defined
    • 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
    • Micha van der Sloot Last revision by Bentley Colleague Micha van der Sloot
    • When: Thu, Dec 17 2020 6:20 AM
    • Revisions: 7
    • 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

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