UserLab CreateSimulation
Jump to navigation
Jump to search
New Simulation |
Menu location |
---|
UserLab → New Simulation |
Phenomena |
UserLab |
Default shortcut |
None |
Introduced in version |
- |
See also |
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 New Simulation button.
- Select the UserLab → 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 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
- DataNumberOfSample: This is the number of sample in a simulation.
- DataNumberOfTimeLags: Number of time lags need for temporal correlation.
- DataStationarity: This specifies whether the simulated phenomenon is stationary or non-stationary.
- DataGaussianity: This specifies whether the simulated phenomenon is gaussian or non-gaussian.
- DataComparisonMode: This specifies whether we are in comparison mode or not.
- DataLargeScaleSimulationMode: This specifies whether we are in large scale simulation mode or not.
- DataIsSimulationSuccessful: This specifies whether the simulation was successful or not.
- DataIsInterruptionRequested: This specifies whether the simulation needs to be interrupted or not.
- DataUniformModulation: This specifies whether a non stataionary phenomenon is uniformly modulated or not.
- DataNumberOfProcess: The number of simulation point which is the number of phenomenon processes in a sample.
- DataLocationIndexJ: The index of the a given process in a field at a location J.
- DataLocationIndexK: The index of the a given process in a field at a location K.
- DataNumberOfFrequency: The number of discrete frequency increments.
- DataFrequencyIncrement: This is the frequency increment value.
- DataMinFrequency: This is the minimum frequency value.
- DataMaxFrequency: This is the maximum frequency value or the cutoff frequency.
- DataFrequencyIndex: Index correponding to Kth discrete frequency increment.
- DataNumberOfTimeIncrements: This is the number of time increments.
- DataTimeIncrement: This is the time increment value.
- DataMinTime: This is the minimum time value.
- DataMaxTime: This is the maximum time value.
- DataTimeIndex: Index correponding to Kth time increment.
- DataNumberOfDirectionIncrements: The number of direction increments.
- DataDirectionIncrement: This is the direction increment value.
- DataMinDirection: This is the minimum direction value.
- DataMaxDirection: This is the maximum direction value.
- DataDirectionIndex: Index correponding to Kth direction increment.
- DataNumberOfWaveLengthIncrements: The number of discrete wave length increment.
- DataWaveLengthIncrement: This is the wave length value.
- DataMinWaveLength: This is the minimum wave length.
- DataMaxWaveLength: This is the maximum wave length.
- DataWaveLengthIndex: Index correponding to Kth wave length increment.
- DataSpatialDistribution: Active location distribution (simulation points distribution) name.
- DataSimulationMethod: Active simulation method name.
- DataNumberOfIncrementOfVariableX: The number of increments for the variable x.
- DataIndexOfVariableX: This current index of the variable x.
- DataIncrementOfVariableX: This is the variable x increment value.
- DataMinVariableX: This is the minimum x variable value
- DataPhenomenon: The random phenonenon name.
- DataWorkingDirectoryPath: The working directory path.
Scripting
- Create new document and add new simulation to it.
import UserLabObjects import LabRPS doc = LabRPS.newDocument() sim = UserLabObjects.makeSimulation(doc, "MySimulation") if not sim: LabRPS.Console.PrintError("The simulation does not exist.\n")
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, AppImage
- Basics: About LabRPS, Interface, RPS Objects, Object name, Preferences, Workbenches, Document structure, Properties, Help LabRPS, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, WindLab, SeismicLab, SeaLab, UserLab, Spreadsheet, Plot, Web
- Hubs: User hub, Power users hub, Developer hub