Ramp User Guide - Revision history

Rsalter: /* The Ramp Application */

2022-02-18T18:11:30Z

The Ramp Application

← Older revision		Revision as of 18:11, 18 February 2022
Line 11:		Line 11:
	==The Ramp Application==		==The Ramp Application==
	===Controls and Features===		===Controls and Features===
	[[File: Ramp1.png\|thumb\|~~200px~~\|Fig 1. Ramp App]]		[[File: Ramp1.png\|thumb\|280px\|Fig 1. Ramp App]]
	[[File: Ramp2.png\|thumb\|~~200px~~\|Fig 1. Ramp Controls]]		[[File: Ramp2.png\|thumb\|280px\|Fig 1. Ramp Controls]]
	Each Ramp implements a single model using a common GUI platform, as shown in Figs. 1 and 2. Here is a description of the features of that platform:		Each Ramp implements a single model using a common GUI platform, as shown in Figs. 1 and 2. Here is a description of the features of that platform:

Rsalter: /* Menu Items */

2022-02-18T17:44:02Z

Menu Items

← Older revision		Revision as of 17:44, 18 February 2022
Line 53:		Line 53:

	'''CSV Menu'''		'''CSV Menu'''
	[[File: csv.png\|thumb\|~~80px~~\|CSV selection]]		[[File: csv.png\|thumb\|280px\|CSV selection]]
	:The Ramp designer can designate particular components and graphs as being available for saving to a CSV (comma separated values) file. The CSV selection window lets the user choose which components to save, the sampling interval, and the directory for the CSV file. Selected components are listed in separate columns in the CSV file.		:The Ramp designer can designate particular components and graphs as being available for saving to a CSV (comma separated values) file. The CSV selection window lets the user choose which components to save, the sampling interval, and the directory for the CSV file. Selected components are listed in separate columns in the CSV file.

	:If '''Autosave''' is selected, CSV files will be saved after each run. A CSV file is given a unique filename containing the name of the Ramp with date and time. Otherwise the user must explicitly save the CSV file after a run or the data will be lost.		:If '''Autosave''' is selected, CSV files will be saved after each run. A CSV file is given a unique filename containing the name of the Ramp with date and time. Otherwise the user must explicitly save the CSV file after a run or the data will be lost.

	[[File: doc.png\|thumb\|~~80px~~\|Ramp Doc]]		[[File: doc.png\|thumb\|280px\|Ramp Doc]]
	'''Help Menu'''		'''Help Menu'''
	:'''About This Ramp''' opens a documentation window that describes parameters and other elements of the model, as detailed by the Ramp designer, and may contain a link to more extensive documentation. It should be viewed by all users of the Ramp. See the example shown here.		:'''About This Ramp''' opens a documentation window that describes parameters and other elements of the model, as detailed by the Ramp designer, and may contain a link to more extensive documentation. It should be viewed by all users of the Ramp. See the example shown here.

Rsalter: /* The Ramp API */

2022-02-17T18:52:28Z

The Ramp API

← Older revision		Revision as of 18:52, 17 February 2022
Line 76:		Line 76:
	==[[The Ramp API]]==		==[[The Ramp API]]==
	===[[The Ramp API#Using Javascript\|Using Javascript]]===		===[[The Ramp API#Using Javascript\|Using Javascript]]===
			===[[The Ramp API#Remote API Access\|Remote API Access]]===
	===[[The Ramp API#R Integration\|R Integration]]===		===[[The Ramp API#R Integration\|R Integration]]===

	==[[Using RAMs]]==		==[[Using RAMs]]==

	===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===		===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===

Rsalter: /* Ramp Window Size */

2022-02-17T16:26:10Z

Ramp Window Size

← Older revision		Revision as of 16:26, 17 February 2022
Line 71:		Line 71:
	===Ramp Window Size===		===Ramp Window Size===
	Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.		Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.

			The following links describe Ramp special features

	==[[The Ramp API]]==		==[[The Ramp API]]==

Rsalter: /* Using RAMs */

2022-02-17T16:25:11Z

Using RAMs

← Older revision		Revision as of 16:25, 17 February 2022
Line 75:		Line 75:
	===[[The Ramp API#Using Javascript\|Using Javascript]]===		===[[The Ramp API#Using Javascript\|Using Javascript]]===
	===[[The Ramp API#R Integration\|R Integration]]===		===[[The Ramp API#R Integration\|R Integration]]===
	===[[Using RAMs]]===		==[[Using RAMs]]==

	===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===		===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===

Rsalter: /* {[The Ramp API]] */

2022-02-17T16:24:56Z

{[The Ramp API]]

← Older revision		Revision as of 16:24, 17 February 2022
Line 72:		Line 72:
	Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.		Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.

	=={[The Ramp API]]==		==[[The Ramp API]]==
	===[[The Ramp API#Using Javascript\|Using Javascript]]===		===[[The Ramp API#Using Javascript\|Using Javascript]]===
	===[[The Ramp API#R Integration\|R Integration]]===		===[[The Ramp API#R Integration\|R Integration]]===
	===[[Using RAMs]]===		===[[Using RAMs]]===
	===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===		===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===

Rsalter: /* Ramp Window Size */

2022-02-17T16:24:43Z

Ramp Window Size

← Older revision		Revision as of 16:24, 17 February 2022
Line 72:		Line 72:
	Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.		Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.

	:[[The Ramp API]]		=={[The Ramp API]]==
	::[[The Ramp API#Using Javascript\|Using Javascript]]		===[[The Ramp API#Using Javascript\|Using Javascript]]===
	::[[The Ramp API#R Integration\|R Integration]]		===[[The Ramp API#R Integration\|R Integration]]===
	:[[Using RAMs]]		===[[Using RAMs]]===
	::[[Using RAMs#What Is A RAM?\|What Is A RAM?]]		===[[Using RAMs#What Is A RAM?\|What Is A RAM?]]===

Rsalter at 16:23, 17 February 2022

2022-02-17T16:23:54Z

← Older revision		Revision as of 16:23, 17 February 2022
Line 72:		Line 72:
	Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.		Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.

	==[[~~Using~~ API ~~Scripts~~]]==		:[[The Ramp API]]
			::[[The Ramp API#Using Javascript\|Using Javascript]]
	==[[Using Javascript]]==		::[[The Ramp API#R Integration\|R Integration]]
			:[[Using RAMs]]
	==[[Using RAMs]]==		::[[Using RAMs#What Is A RAM?\|What Is A RAM?]]

Rsalter: /* Miscellaneous */

2022-02-16T23:32:57Z

Miscellaneous

← Older revision		Revision as of 23:32, 16 February 2022
Line 71:		Line 71:
	===Ramp Window Size===		===Ramp Window Size===
	Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.		Adjusting the size of the Ramp window will cause the display and sliders to change their layout. Ramp window dimensions are store as part of the workspace settings and will be used when those settings are reloaded.

			==[[Using API Scripts]]==

			==[[Using Javascript]]==

			==[[Using RAMs]]==

Rsalter: /* Menu Items */

2022-02-16T22:02:31Z

Menu Items

← Older revision		Revision as of 22:02, 16 February 2022
Line 61:		Line 61:
	'''Help Menu'''		'''Help Menu'''
	:'''About This Ramp''' opens a documentation window that describes parameters and other elements of the model, as detailed by the Ramp designer, and may contain a link to more extensive documentation. It should be viewed by all users of the Ramp. See the example shown here.		:'''About This Ramp''' opens a documentation window that describes parameters and other elements of the model, as detailed by the Ramp designer, and may contain a link to more extensive documentation. It should be viewed by all users of the Ramp. See the example shown here.
			<br clear="all">

	==Miscellaneous==		==Miscellaneous==