LabRPS at 00:58, 23 December 2024

2024-12-23T00:58:47Z

← Older revision		Revision as of 17:58, 22 December 2024
Line 25:		Line 25:
	#* Select the {{MenuCommand\|UserLab → [[Image:UserLab_CreateSimulation.svg\|16px]] New Simulation}} option from the menu.		#* Select the {{MenuCommand\|UserLab → [[Image:UserLab_CreateSimulation.svg\|16px]] New Simulation}} option from the menu.
	# A new Simulation is created and set to active.		# A new Simulation is created and set to active.
	# Any UserLab Features (objects) could be added or removed from the simulation from [[Image:UserLab_CreateFeature.svg\|~~32px~~]] [[UserLab_CreateFeature\|Create Feature]].		# Any UserLab Features (objects) could be added or removed from the simulation from [[Image:UserLab_CreateFeature.svg\|16px]] [[UserLab_CreateFeature\|Create Feature]].
	# To add new UserLab Features (objects) to the document the simulation has to be active. Double-clicking on the simulation container activates the simulation.		# To add new UserLab Features (objects) to the document the simulation has to be active. Double-clicking on the simulation container activates the simulation.

LabRPS: Created page with "{{Docnav |SeaLab Workbench |Create Features |UserLab |IconL=Workbench_SeaLab.svg |IconR=UserLab_CreateFeature.svg |IconC=Workbench_UserLab.svg }} {{GuiCommand |Name=New Simulation |MenuLocation=UserLab → New Simulation |Phenomena=UserLab |SeeAlso=UserLab tutorial }} ==Description== The UserLab Simulation could be seen as a container that holds all objects..."

2024-11-13T15:33:43Z

Created page with "{{Docnav |SeaLab Workbench |Create Features |UserLab |IconL=Workbench_SeaLab.svg |IconR=UserLab_CreateFeature.svg |IconC=Workbench_UserLab.svg }} {{GuiCommand |Name=New Simulation |MenuLocation=UserLab → New Simulation |Phenomena=UserLab |SeeAlso=UserLab tutorial }} ==Description== The UserLab Simulation could be seen as a container that holds all objects..."

New page

{{Docnav
|[[SeaLab_Workbench|SeaLab Workbench]]
|[[UserLab_CreateFeature|Create Features]]
|[[UserLab_Workbench|UserLab]]
|IconL=Workbench_SeaLab.svg
|IconR=UserLab_CreateFeature.svg
|IconC=Workbench_UserLab.svg
}}

{{GuiCommand
|Name=New Simulation
|MenuLocation=UserLab → New Simulation
|Phenomena=[[UserLab_Workbench|UserLab]]
|SeeAlso=[[UserLab_tutorial|UserLab tutorial]]
}}

==Description==

The UserLab Simulation could be seen as a container that holds all objects of random phenomenon simulation. It is mandatory to have a simulation container that holds all the needed objects.

==Usage==

# There are several ways to invoke the command:
#* Press the {{Button|[[Image:UserLab_CreateSimulation.svg|16px]] [[UserLab_CreateSimulation|New Simulation]]}} button.
#* Select the {{MenuCommand|UserLab → [[Image:UserLab_CreateSimulation.svg|16px]] New Simulation}} option from the menu.
# A new Simulation is created and set to active.
# Any UserLab Features (objects) could be added or removed from the simulation from [[Image:UserLab_CreateFeature.svg|32px]] [[UserLab_CreateFeature|Create Feature]].
# To add new UserLab Features (objects) to the document the simulation has to be active. Double-clicking on the simulation container activates the simulation.

==Properties==

* {{PropertyData|NumberOfSample}}: This is the number of sample in a simulation.
* {{PropertyData|NumberOfTimeLags}}: Number of time lags need for temporal correlation.
* {{PropertyData|Stationarity}}: This specifies whether the simulated phenomenon is stationary or non-stationary.
* {{PropertyData|Gaussianity}}: This specifies whether the simulated phenomenon is gaussian or non-gaussian.
* {{PropertyData|ComparisonMode}}: This specifies whether we are in comparison mode or not.
* {{PropertyData|LargeScaleSimulationMode}}: This specifies whether we are in large scale simulation mode or not.
* {{PropertyData|IsSimulationSuccessful}}: This specifies whether the simulation was successful or not.
* {{PropertyData|IsInterruptionRequested}}: This specifies whether the simulation needs to be interrupted or not.
* {{PropertyData|UniformModulation}}: This specifies whether a non stataionary phenomenon is uniformly modulated or not.
* {{PropertyData|NumberOfProcess}}: The number of simulation point which is the number of phenomenon processes in a sample.
* {{PropertyData|LocationIndexJ}}: The index of the a given process in a field at a location J.
* {{PropertyData|LocationIndexK}}: The index of the a given process in a field at a location K.
* {{PropertyData|NumberOfFrequency}}: The number of discrete frequency increments.
* {{PropertyData|FrequencyIncrement}}: This is the frequency increment value.
* {{PropertyData|MinFrequency}}: This is the minimum frequency value.
* {{PropertyData|MaxFrequency}}: This is the maximum frequency value or the cutoff frequency.
* {{PropertyData|FrequencyIndex}}: Index correponding to Kth discrete frequency increment.
* {{PropertyData|NumberOfTimeIncrements}}: This is the number of time increments.
* {{PropertyData|TimeIncrement}}: This is the time increment value.
* {{PropertyData|MinTime}}: This is the minimum time value.
* {{PropertyData|MaxTime}}: This is the maximum time value.
* {{PropertyData|TimeIndex}}: Index correponding to Kth time increment.
* {{PropertyData|NumberOfDirectionIncrements}}: The number of direction increments.
* {{PropertyData|DirectionIncrement}}: This is the direction increment value.
* {{PropertyData|MinDirection}}: This is the minimum direction value.
* {{PropertyData|MaxDirection}}: This is the maximum direction value.
* {{PropertyData|DirectionIndex}}: Index correponding to Kth direction increment.
* {{PropertyData|NumberOfWaveLengthIncrements}}: The number of discrete wave length increment.
* {{PropertyData|WaveLengthIncrement}}: This is the wave length value.
* {{PropertyData|MinWaveLength}}: This is the minimum wave length.
* {{PropertyData|MaxWaveLength}}: This is the maximum wave length.
* {{PropertyData|WaveLengthIndex}}: Index correponding to Kth wave length increment.
* {{PropertyData|SpatialDistribution}}: Active location distribution (simulation points distribution) name.
* {{PropertyData|SimulationMethod}}: Active simulation method name.
* {{PropertyData|NumberOfIncrementOfVariableX}}: The number of increments for the variable x.
* {{PropertyData|IndexOfVariableX}}: This current index of the variable x.
* {{PropertyData|IncrementOfVariableX}}: This is the variable x increment value.
* {{PropertyData|MinVariableX}}: This is the minimum x variable value
* {{PropertyData|Phenomenon}}: The random phenonenon name.
* {{PropertyData|WorkingDirectoryPath}}: The working directory path.

==Scripting==

* Create new document and add new simulation to it.

{{Code|code=
import UserLabObjects
import LabRPS
doc = LabRPS.newDocument()
sim = UserLabObjects.makeSimulation(doc, "MySimulation")
if not sim:
LabRPS.Console.PrintError("The simulation does not exist.\n")
}}

{{Docnav
|[[SeaLab_Workbench|SeaLab Workbench]]
|[[UserLab_CreateFeature|Create Features]]
|[[UserLab_Workbench|UserLab]]
|IconL=Workbench_SeaLab.svg
|IconR=UserLab_CreateFeature.svg
|IconC=Workbench_UserLab.svg
}}

{{UserLab Tools navi}}
{{Userdocnavi}}

UserLab CreateSimulation - Revision history

LabRPS at 00:58, 23 December 2024