Scripting Tools
The Scripting menu includes various tools that allow users to manage the scripting server, access the RocScript Editor and its environment, and view the reference manual.
Manage Scripting Server
This option opens the Scripting Server Manager dialog. You can set the server and its port number here.
Similar to other APIs, RSPile Scripting requires a server started. The server listens for incoming requests from clients (i.e., your python script) on a specific port number, and connects to the RSPile program.
How to use
Users have the option to either manually configure settings in the dialog interface or programmatically initiate operations using the function provided in the RSPile Python API Library.
To start the server in the dialog:
- Select Available Port by entering a port number in the field or using the up/down buttons at the side.
- The port availability will be displayed, as “Available” or “Unavailable”. “Unavailable” means the port is currently occupied by another server. You can click the Find Port button to search for the next available port.
- To start the server on the specified port, click the Start Server button.
- The Server Status note describes whether this server is running or not.
Alternatively, you can incorporate the startApplication() function within your python script, which bypasses the manual steps outlined above.
For example:
It starts the RSPile application and a server connected to it at port number 60044.
# Start RSPILE Modeler
RSPILEModeler.startApplication(port=60044)See the Scripting Tutorials here for more examples.
Stop the Server
To stop a started server, you can click on Stop Server button in the dialog.
- Using a script, you can concurrently run multiple projects by assigning them to different ports. This approach is time efficient.
Meanwhile, if you want to terminate one or more projects associated with a specific port, you can stop the server. This action cuts out the connection between the projects and the API, and frees up the port for other projects or tasks.
There is no associated function in the RSPile Python API Library. Closing the application window will automatically terminate the server connected to it.
Launch RocScript Editor
Clicking Launch RocScript Editor opens RocScript Editor application, which is the pre-configured Python editor. You can alternative open the RocScript Editor from the Windows start menu.
Manage Python Environment
The Manage Python Environment option opens the pre-configured Python editor environment – RocScript WinPython Command Prompt.
This RocScript Command Prompt is used to manage the python environment within the RocScript Editor. For advanced users who prefer to use their own python environment, use the Windows Command Prompt instead.
For more information about the python environment, see the tutorial – Getting Started with RSPile Scripting.
Reference Manual
The Scripting Reference Manual lists out all object, method, class, and function in the RSPile Python API Library for client. Script examples are also provided in the guide. Refer to this guide to utilize RSPile Scripting.
The manual can also be found here.