The Ramp API

From Numerus
Revision as of 16:55, 17 February 2022 by Rsalter (talk | contribs) (→‎Using RPL)
Jump to navigation Jump to search

The Ramp API (Application Programming Interface) uses a simple language called RPL to manage and operate Ramp simulations and retrieve data for remote processing. It can be used in three ways: directly, through the RPL Scripting Portal (S On/Off button); indirectly through the Javascript RPL Portal (JS On/Off button); and remotely from other platforms such as the R Statistical language.

Using RPL

Fig 1. RPL Scripting Portal

RPL is aimple bytecode with instructions for adjusting parameter values, controlling runs, and retrieving data. There are RPL instructions to perform virtually any task a user might perform directly by changing sliders, adjusting runtimes or saving data to CSV files.

The RPL Reference sheet can be viewed using the Command Reference button on the RPL Scripting Portal. It is shown below in Fig 2. Fig 2. RPL Reference Each instruction in RPL consists of an op code followed by 0 or more arguments.

Using Javascript

R Integration

Retrieved from "https://wiki.numerusinc.com/index.php?title=The_Ramp_API&oldid=1465"