Hi,
I am a student at NTNU and I am currently working on a preparation project for my master's thesis about Plaxis remote scripting and Python, and I have a couple of questions regarding remote scripting.
The PLAXIS software provides an HTTP based API (REST HTTP API), for which a special Python wrapper was developed for an easy to use scripting API. Both PLAXIS Input and PLAXIS Output support this usage of a Remote Scripting server.
Best regards,
Dina Hansen
Dear Dina,
API stands for Application Programming Interface. PLAXIS has implemented an interface that allows users to do normal PLAXIS tasks such as creating projects, run commands, etc.
So to answer your question, I would say: PLAXIS software has implemented a Python wrapper for the HTTP REST API that allows a developer or user to do normal PLAXIS tasks such as creating projects, firing regular commands as found on the existing command line, performing meshing and calculations.
The API here is the interface, like a fancy door you can walk through, that allows the Python scripting to work.
In principle using the API you can use any (*) programming language to communicate with PLAXIS software. The asterisk here is for being clear that this is possible but you need to implement this yourself. PLAXIS provides a Python wrapper with the installation, but it is possible to implement a different wrapper that can use our API.
Specifically, the API implemented by PLAXIS is an HTTP based API, which stands for Hypertext Transfer Protocol, indicating the communication protocol used.
Note that REST stands for Representation State Transfer. It is a simple, standard API model behind most modern web services.
Dear Stefanos Papavasileiou,
Thank you for a good explanation
So in the sentence below, is "remote scripting interface" the same as HTTP REST API? And HTTP REST API is an interface between Plaxis and Python that enables these programs to communicate (like a fancy door)?
The remote scripting interface is based on the Python language and allows users to control both the Input and Output program via an external Python handler, for example IDLE, to either directly input commands on-the-fly or to run script files.
Thank you.
The remote scripting interface or API or HTTP REST API is not written on Python. Using the Python wrapper we have implemented makes it possible to use Python language to communicate via the API with PLAXIS.
Yes, the remote scripting interface is the API, but the sentence is not entirely accurate.
Note that we no longer use Python's IDLE to communicate with PLAXIS.
You can check more information on the workflow here: https://communities.bentley.com/products/geotech-analysis/w/plaxis-soilvision-wiki/46005/using-plaxis-remote-scripting-with-the-python-wrapper
If you need extra assistance, please consider submitting a Service Request: https://apps.bentley.com/srmanager/ProductSupport