The Ramp API - Revision history

Rsalter: /* R Integration */

2022-02-21T19:14:54Z

R Integration

← Older revision		Revision as of 19:14, 21 February 2022
Line 52:		Line 52:

	==R Integration==		==R Integration==
	To facilitate integration with R we have created the '''nmbR''' package which can be downloaded from Numerus and installed into the R environment. Here is the current list of '''nmbR''' functions, taken from the "help" page for the package:		To facilitate integration with R we have created the '''nmbR''' package which can be downloaded from Numerus and installed into the R environment. To install the R package execute

			<code>install.packages(".../nmbR_0.1.0.tar.gz", repos = NULL, type = "source")</code>

			where ... is the path to the tar.gz file obtained from the download.

			Here is the current list of '''nmbR''' functions, taken from the "help" page for the package:

	[[File:nmbr.png]]		[[File:nmbr.png]]

Rsalter: /* Using Javascript */

2022-02-18T20:08:46Z

Using Javascript

← Older revision		Revision as of 20:08, 18 February 2022
Line 39:		Line 39:
	The '''Go''' button provides a convenient way of executing a script. If the entry point of the script is defined as the function '''go()''', clicking the button will invoke the script, so that typing into the console is not necessary.		The '''Go''' button provides a convenient way of executing a script. If the entry point of the script is defined as the function '''go()''', clicking the button will invoke the script, so that typing into the console is not necessary.

	'''Note''': If a JS script fails to execute the first time after being loaded, click '''Reset Console''' and reload the script.		'''Note''': ''If a JS script fails to execute the first time after being loaded, click '''Reset Console''' and reload the script''.

	As with RPL scripts, JS Scripts can be saved and loaded, and any script left in the editor will be part of the Ramp settings.		As with RPL scripts, JS Scripts can be saved and loaded, and any script left in the editor will be part of the Ramp settings.

Rsalter: /* Using Javascript */

2022-02-18T20:08:30Z

Using Javascript

← Older revision		Revision as of 20:08, 18 February 2022
Line 38:		Line 38:

	The '''Go''' button provides a convenient way of executing a script. If the entry point of the script is defined as the function '''go()''', clicking the button will invoke the script, so that typing into the console is not necessary.		The '''Go''' button provides a convenient way of executing a script. If the entry point of the script is defined as the function '''go()''', clicking the button will invoke the script, so that typing into the console is not necessary.

			'''Note''': If a JS script fails to execute the first time after being loaded, click '''Reset Console''' and reload the script.

	As with RPL scripts, JS Scripts can be saved and loaded, and any script left in the editor will be part of the Ramp settings.		As with RPL scripts, JS Scripts can be saved and loaded, and any script left in the editor will be part of the Ramp settings.

Rsalter: /* Using Javascript */

2022-02-18T17:00:58Z

Using Javascript

← Older revision		Revision as of 17:00, 18 February 2022
Line 33:		Line 33:

	==Using Javascript==		==Using Javascript==
	[[File:~~jsscript~~.png\|thumb\|280px\|Fig. 5 Javascript RPL Portal with Script]]		[[File:jsscript1.png\|thumb\|280px\|Fig. 5 Javascript RPL Portal with Script]]

	The RPL Scripting Portal is especially useful for building and testing scripts. However since the RPL language contains no control structures, the Javascript RPL Portal provides a richer programming environment for scripting Ramps. The console (left window) in this portal is a complete Javascript runtime extended by an object bound to '''$$'''. This object contains functions corresponding to each of the RPL operators, plus the function '''dispatch''', which can be used to invoke a sequence of RPL commands as strings. Both usages are shown in Fig. 5, which executes the same script as in the previous section but using a loop structure to achieve greater economy. The use of '''$$.dispatch''' shows how command can be sequenced in one line.		The RPL Scripting Portal is especially useful for building and testing scripts. However since the RPL language contains no control structures, the Javascript RPL Portal provides a richer programming environment for scripting Ramps. The console (left window) in this portal is a complete Javascript runtime extended by an object bound to '''$$'''. This object contains functions corresponding to each of the RPL operators, plus the function '''dispatch''', which can be used to invoke a sequence of RPL commands as strings. Both usages are shown in Fig. 5, which executes the same script as in the previous section but using a loop structure to achieve greater economy. The use of '''$$.dispatch''' shows how command can be sequenced in one line.

Rsalter: /* R Integration */

2022-02-18T15:19:50Z

R Integration

← Older revision		Revision as of 15:19, 18 February 2022
Line 58:		Line 58:
	The function <code>nmbR$frame</code> is used to retrieve data from the Ramp and return it in the form of an R dataframe. Similarly, <code>nmbr$graph</code> will graph these data as a time series.		The function <code>nmbR$frame</code> is used to retrieve data from the Ramp and return it in the form of an R dataframe. Similarly, <code>nmbr$graph</code> will graph these data as a time series.

	Please refer to the example R scripts downloadable from Numerus for further details.		Please refer to the example R scripts downloadable from Numerus for further details. Examples also appear in the package's "help" page.

	This package will likely grow in size in future releases as more is learned about ways that R and Ramp simulations can interact.		This package will likely grow in size in future releases as more is learned about ways that R and Ramp simulations can interact.
	<hr>		<hr>

Rsalter: /* R Integration */

2022-02-18T15:18:24Z

R Integration

← Older revision		Revision as of 15:18, 18 February 2022
Line 61:		Line 61:

	This package will likely grow in size in future releases as more is learned about ways that R and Ramp simulations can interact.		This package will likely grow in size in future releases as more is learned about ways that R and Ramp simulations can interact.
			<hr>

Rsalter: /* R Integration */

2022-02-18T15:17:56Z

R Integration

← Older revision		Revision as of 15:17, 18 February 2022
Line 50:		Line 50:

	==R Integration==		==R Integration==
	To facilitate integration with R we have created the '''nmbR''' package which can be downloaded from Numerus and installed into the R environment. Here is the current list of '''nmbR''' functions:		To facilitate integration with R we have created the '''nmbR''' package which can be downloaded from Numerus and installed into the R environment. Here is the current list of '''nmbR''' functions, taken from the "help" page for the package:

	[[File:nmbr.png]]		[[File:nmbr.png]]

	The principal function in this package is <code>nmbR$dispatch(s)</code>, where <code>s</code> is a string of RPL commands. This function sends the RPL string to the Ramp and returns the Ramp's reply.		The principal function in this package is <code>nmbR$dispatch(s)</code>, where <code>s</code> is a string of RPL commands. This function sends the RPL string to the Ramp and returns the Ramp's reply.

			The function <code>nmbR$frame</code> is used to retrieve data from the Ramp and return it in the form of an R dataframe. Similarly, <code>nmbr$graph</code> will graph these data as a time series.

			Please refer to the example R scripts downloadable from Numerus for further details.

			This package will likely grow in size in future releases as more is learned about ways that R and Ramp simulations can interact.

Rsalter: /* R Integration */

2022-02-18T15:10:34Z

R Integration

← Older revision		Revision as of 15:10, 18 February 2022
Line 50:		Line 50:

	==R Integration==		==R Integration==
			To facilitate integration with R we have created the '''nmbR''' package which can be downloaded from Numerus and installed into the R environment. Here is the current list of '''nmbR''' functions:

			[[File:nmbr.png]]

			The principal function in this package is <code>nmbR$dispatch(s)</code>, where <code>s</code> is a string of RPL commands. This function sends the RPL string to the Ramp and returns the Ramp's reply.

Rsalter: /* Remote API Access */

2022-02-18T14:58:19Z

Remote API Access

← Older revision		Revision as of 14:58, 18 February 2022
Line 46:		Line 46:

	Each Ramp launched from Numerus Studio is assigned a distinct port number, beginning with the base port shown on the Studio dashboard. The number assigned is either the base port or the smallest number larger than any port currently in operation. The port number also appears on the title bar of the Ramp. Note that if only a single Ramp is launched it will always be assigned the base port number. Numerus Studio is distributed with base port 8585. In the unlikely situation that this port is already in use on your computer for other purposes you can change the base port on the Studio dashboard, and subsequent launches will use the new base port.		Each Ramp launched from Numerus Studio is assigned a distinct port number, beginning with the base port shown on the Studio dashboard. The number assigned is either the base port or the smallest number larger than any port currently in operation. The port number also appears on the title bar of the Ramp. Note that if only a single Ramp is launched it will always be assigned the base port number. Numerus Studio is distributed with base port 8585. In the unlikely situation that this port is already in use on your computer for other purposes you can change the base port on the Studio dashboard, and subsequent launches will use the new base port.

			Remote API access enables integration of Numerus Ramps with other programming platforms such as Python, Ruby, etc. and in the future could allow Ramps to communicate with each other. The R statistical platform is an obvious partner for operating and analyzing Ramp simulations. Details are in the next section.

	==R Integration==		==R Integration==

Rsalter: /* Remote API Access */

2022-02-18T14:51:59Z

Remote API Access

← Older revision		Revision as of 14:51, 18 February 2022
Line 45:		Line 45:
	When a Ramp is launched it uses your computer's internet facility to listen for and respond to RPL commands as if they were coming from the RPL Scripting or Javascript Portals. Any other program running on your machine can address the Ramp using the port number that appears on the Scripting Portal.<ref>'''Important''': the Ramp only interacts with programs running on the same machine (the <code>localhost</code>).</ref>		When a Ramp is launched it uses your computer's internet facility to listen for and respond to RPL commands as if they were coming from the RPL Scripting or Javascript Portals. Any other program running on your machine can address the Ramp using the port number that appears on the Scripting Portal.<ref>'''Important''': the Ramp only interacts with programs running on the same machine (the <code>localhost</code>).</ref>

	Each Ramp launched from Numerus Studio is assigned a distinct port number, beginning with the base port shown on the Studio dashboard. The number assigned is either the base port or the smallest number larger than any port currently in operation. The port number also appears on the title bar of the Ramp. Note that if only a single Ramp is launched it will always be assigned the base port number. Numerus Studio is distributed with base port 8585. In the unlikely situation that this port is already in use on your computer for other purposes you can change the base port on the Studio dashboard, and subsequent launches will use the new port.		Each Ramp launched from Numerus Studio is assigned a distinct port number, beginning with the base port shown on the Studio dashboard. The number assigned is either the base port or the smallest number larger than any port currently in operation. The port number also appears on the title bar of the Ramp. Note that if only a single Ramp is launched it will always be assigned the base port number. Numerus Studio is distributed with base port 8585. In the unlikely situation that this port is already in use on your computer for other purposes you can change the base port on the Studio dashboard, and subsequent launches will use the new base port.

	==R Integration==		==R Integration==