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. More information on the scripting server can be found in the article Using PLAXIS Remote scripting with the Python wrapper.

The documentation is launched on a browser window and includes information and full examples of all available commands in PLAXIS Input & Output programs.

Workflow explained

In order to use the Scripting reference, you can follow the workflow below: 

1. Identify command to run with Python scripting
    - use Graphic User Interface (GUI) or check the command line session
    - use Help > Command reference 
2. Go to PLAXIS Input program (also for Output commands) 
3. Open menu Help > Scripting reference 
4. Set up the Configure remote scripting server window 
5. Find the command for Input or Output in alphabetical order 
6. Click on the command name (the example will open in new tab)
7. ►| Run (cell by cell)
   or 
   select: Cell > Run All
8. Jupyter notebook runs the example and provides the response(s) from Plaxis 
9. Check PLAXIS Input/Output to see the example 
   

Figure 1. Scripting reference Jupyter notebook

Figure 2. Python example for command calculate

For more information on Python Jupyter Notebooks, follow the link to: 
https://jupyter-notebook.readthedocs.io/en/stable/