Getting started - Revision history

LabRPS at 22:18, 22 November 2024

2024-11-22T22:18:01Z

← Older revision		Revision as of 15:18, 22 November 2024
Line 13:		Line 13:
	# Sea surface		# Sea surface

			Note that, apart from these three phenomena, LabRPS has also provided a general for the simulation of any random phenomenon.
	LabRPS has been under development since 2015, and it offers a large list of [[Feature_list\|features]]. Capabilities are still missing but it is powerful enough to be used. There is a fast-growing community of enthusiastic users who participate in the [https://labrps.com/boards LabRPS forum], and you can find [https://labrps.com/boards many examples] of quality projects developed with LabRPS there.		LabRPS has been under development since 2015, and it offers a large list of [[Feature_list\|features]]. Capabilities are still missing but it is powerful enough to be used. There is a fast-growing community of enthusiastic users who participate in the [https://labrps.com/boards LabRPS forum], and you can find [https://labrps.com/boards many examples] of quality projects developed with LabRPS there.

Line 22:		Line 23:
	* [[Video_tutorials\|Video tutorials]]		* [[Video_tutorials\|Video tutorials]]

	==~~Installing~~==		==First steps with LabRPS==

			LabRPS's focus is to allow you to numerically generate random phenomena in an accuarate and realistic way, to allow researchers quicky developing new simulation tools. It is therefore very different from some other applications made for similar purposes. Its learning curve is made very short. If you are struck at some point, don't forget that the friendly community of users on the [https://labrps.com/boards LabRPS forum] might be able to get you out in no time. These are the basics steps to numerically generate random phenomenon:

			=== Step 1: Install LabRPS ===
			First of all, download and install LabRPS. See the [[Download\|Download]] page for information on current versions and updates, and the installation instructions for your operating system ([[Installing_on_Windows\|Windows]], [[Installing_on_Linux\|Linux]] or [[Installing_on_Mac\|Mac]]). There are install packages ready for Windows (.msi), Debian and Ubuntu (.deb), openSUSE (.rpm), and Mac OSX. LabRPS is available from the package managers of many other Linux distributions. A standalone [[AppImage\|AppImage]] executable is also available, which will run on most recent 64-bit Linux systems. As LabRPS is open-source, you can also grab the source code and [[Compiling\|compile]] it yourself.

			=== Step 2: Install Plugins ===
			Now start the application and wait for it to open and load all its module. Activate the workbench of your random phenomenon. The plugin you will start working with in LabRPS depends on the type of random phenomenon you need to simulate. If you are going to work on random wind velocity, you'll probably want to activate the [[WindLab_Workbench\|WindLab Workbench]]. If you are going to work on seismic ground motion, then switch to the [[SeismicLab_Workbench\|SeismicLab Workbench]]. After activating the appropriate workbench, go to {{MenuCommand\|Tools → [[Image:Std_DlgRPSFeatures.svg\|16px]] Feature Manager...}} to install the plugin of your choice.

			=== Step 3: Feature Creation ===
			Before you can create a feature you need to create a document and a new simulation. Create a new document and add a new simulation to it according to the active workbench. Then you can create a feature (a simulation method for example).

	~~First of all, download and install LabRPS. See~~ the ~~[[Download\|Download]] page for information on current versions and updates,~~ and the installation instructions for you operating system ([[Installing_on_Windows\|Windows]], [[Installing_on_Linux\|Linux]] or [[Installing_on_Mac\|Mac]]). There are install packages ready for Windows (.msi), Debian and Ubuntu (.deb), openSUSE (.rpm), and Mac OSX. LabRPS is available from the ~~package managers~~ of ~~many other Linux distributions~~. ~~A standalone [[AppImage\|AppImage]] executable is also available, which~~ will ~~run on most recent 64-bit Linux systems. As LabRPS is open-source, you can also grab~~ the ~~source code and [[Compiling\|compile]] it yourself~~.		=== Step 4: Run the Feature ===
			Now to the tree view and right click the newly created feature then choose one action from the top of the context menu. Computation will be executed and result will be shown in the form of table.

	==Exploring the interface==		==Exploring the interface==


	[[File:LabRPS_interface_base_divisions.png\|1024px]]		[[File:LabRPS_interface_base_divisions.png\|1024px]]
Line 48:		Line 62:

	The Start page allows you to quickly jump to one of the most common workbenches, open one of the recent files, or see the latest news from the LabRPS world. You can change the default workbench in the [[Preferences_Editor\|preferences]].		The Start page allows you to quickly jump to one of the most common workbenches, open one of the recent files, or see the latest news from the LabRPS world. You can change the default workbench in the [[Preferences_Editor\|preferences]].

	~~==First steps with LabRPS==~~

	LabRPS's focus is to allow you to numerically generate random phenomena in an accuarate and realistic way, to allow researchers quicky developing new simulation tools. It is therefore very different from some other applications made for similar purposes. Its learning curve is made very short. If you are struck at some point, don't forget that the friendly community of users on the [https://labrps.com/boards LabRPS forum] might be able to get you out in no time.

	The plugin you will start working with in LabRPS depends on the type of random phenomenon you need to simulate. If you are going to work on random wind velocity, you'll probably want to activate the [[WindLab_Workbench\|WindLab Workbench]]. If you are going to work on seismic ground motion, then switch to the [[SeismicLab_Workbench\|SeismicLab Workbench]].

	==Working with WindLab==		==Working with WindLab==
	WindLab is a module in LabRPS that provides and manages all LabRPS's capabilities for the simulation of stochastic wind velocity. This module is automatically actived when you active the [[WindLab_Workbench\|WindLab Workbench]]. Don't confuse [[WindLab_Workbench\|WindLab]] and [[~~WindLab_Plugin~~\|WindLab Plugin]]. WindLab, also called [[WindLab_Workbench\|WindLab Workbench]] is LabRPS internal module providing the simulation framework of random wind velocity while [[~~WindLab_Plugin~~\|WindLab Plugin]] is one of the offical plugins provided by LabRPS for simulation of random wind velocity.		WindLab is a module in LabRPS that provides and manages all LabRPS's capabilities for the simulation of stochastic wind velocity. This module is automatically actived when you active the [[WindLab_Workbench\|WindLab Workbench]]. Don't confuse [[WindLab_Workbench\|WindLab]] and [[Plugin_WindLab\|WindLab Plugin]]. WindLab, also called [[WindLab_Workbench\|WindLab Workbench]] is LabRPS internal module providing the simulation framework of random wind velocity while [[Plugin_WindLab\|WindLab Plugin]] is one of the offical plugins provided by LabRPS for simulation of random wind velocity.
	This is a typical WindLab workflow:		This is a typical WindLab workflow:

	# Create new [[~~WindLab_New~~\|wind velocity simulation]]		# Create new [[WindLab_CreateSimulation\|wind velocity simulation]]
	# Edit the properties of newly created wind velocity simulation to switch your need.		# Edit the properties of newly created wind velocity simulation to switch your need.
	# Create new [[~~WindLab_NewFeature~~\|WindLab feature]] (simulation points, mean wind profile, wind spectrum, etc.)		# Create new [[WindLab_Feature\|WindLab feature]] (simulation points, mean wind profile, wind spectrum, etc.)
	# Right click on the created feature in the [[tree_view\|tree view]] and select action to run the feature and show computation results.		# Right click on the created feature in the [[tree_view\|tree view]] and select action to run the feature and show computation results.

LabRPS at 17:00, 29 October 2024

2024-10-29T17:00:00Z

Show changes

LabRPS: /* Foreword */

2024-07-27T17:22:12Z

Foreword

← Older revision		Revision as of 10:22, 27 July 2024
Line 8:		Line 8:
	==Foreword==		==Foreword==

	LabRPS is a computation tool for the [[About_LabRPS\|numerical simulation of random phenomena]]. It is ~~primarily made~~ for ~~researchers~~, ~~but also serves all other~~ who need to numerically ~~reprent~~ a random phenomenon ~~without being involved with coding~~.		LabRPS is a computation tool for the [[About_LabRPS\|numerical simulation of random phenomena]]. It is designed for Researchers, Scientics, Engineers, Students and others who need to numerically represent a random phenomenon. Currently,, three phenomena are implemented in LabRPS:
			# Stochastic wind velocity
			# Seismic ground motion
			# Sea surface

	LabRPS has been under development since 2015, and it offers a large list of [[Feature_list\|features]]. Capabilities are still missing but it is powerful enough ~~for hobbyist use, and small workshops~~. There is a fast-growing community of enthusiastic users who participate in the [https://labrps.com/boards LabRPS forum], and you can find [https://labrps.com/boards many examples] of quality projects developed with LabRPS there.		LabRPS has been under development since 2015, and it offers a large list of [[Feature_list\|features]]. Capabilities are still missing but it is powerful enough to be used. There is a fast-growing community of enthusiastic users who participate in the [https://labrps.com/boards LabRPS forum], and you can find [https://labrps.com/boards many examples] of quality projects developed with LabRPS there.

	Like all free software projects, LabRPS depends on its community to grow, gain features, and fix bugs. Don't forget this when using LabRPS; if you like it, you can [[Donate\|donate]] and [[Help_LabRPS\|help LabRPS]] in various ways, such as writing documentation.		Like all free software projects, LabRPS depends on its community to grow, gain features, and fix bugs. Don't forget this when using LabRPS; if you like it, you can [[Donate\|donate]] and [[Help_LabRPS\|help LabRPS]] in various ways, such as writing documentation.

LabRPS: /* Working with SeaLab */

2022-08-24T16:12:55Z

Working with SeaLab

← Older revision		Revision as of 09:12, 24 August 2022
Line 87:		Line 87:

	==Working with SeaLab==		==Working with SeaLab==
	~~<coming soon>~~		{{VeryImportantMessage\|Section TBD}}

	==Scripting==		==Scripting==

LabRPS: /* Working with SeismicLab */

2022-08-24T16:12:30Z

Working with SeismicLab

← Older revision		Revision as of 09:12, 24 August 2022
Line 84:		Line 84:

	==Working with SeismicLab==		==Working with SeismicLab==
	~~<coming soon>~~		{{VeryImportantMessage\|Section TBD}}

	==Working with SeaLab==		==Working with SeaLab==

LabRPS at 20:29, 22 August 2022

2022-08-22T20:29:10Z

← Older revision		Revision as of 13:29, 22 August 2022
Line 52:		Line 52:
	The Start page allows you to quickly jump to some parts of the application, open one of the recent files, or see the latest news from the LabRPS world. You can change the default phenomenon in the [[Std_Phenomenon\|phenomenon selector]].		The Start page allows you to quickly jump to some parts of the application, open one of the recent files, or see the latest news from the LabRPS world. You can change the default phenomenon in the [[Std_Phenomenon\|phenomenon selector]].

	== ~~Navigating in the 3D space~~ ==		== Navigation style ==

	LabRPS has ~~several~~ [[Mouse_navigation\|navigation ~~modes~~]] ~~available~~, that ~~change~~ the way you use your mouse to interact with the ~~objects~~ in the 3D view and the ~~view itself~~.		LabRPS has a[[Mouse_navigation\|navigation style]] , that changes the way you use your mouse to interact with the items in the 3D view and the other views.

	==First steps with LabRPS==		==First steps with LabRPS==

	LabRPS's focus is to allow you numerically generate random phenomena in an accuarate and realistic way, to allow researchers quicky developing new simulation tools. It is therefore very different from some other applications made for similar purposes. Its learning curve is make very short. If you are struck at some point, don't forget that the friendly community of users on the [https://labrps.com/boards LabRPS forum] might be able to get you out in no time.		LabRPS's focus is to allow you to numerically generate random phenomena in an accuarate and realistic way, to allow researchers quicky developing new simulation tools. It is therefore very different from some other applications made for similar purposes. Its learning curve is make very short. If you are struck at some point, don't forget that the friendly community of users on the [https://labrps.com/boards LabRPS forum] might be able to get you out in no time.

	The plugin you will start using in LabRPS depends on the type random phenomenon you need to simulate: If you are going to work on random wind velocity, you'll probably want to try the [[windLab_Plugin\|windLab Plugin]]. If you will work on seismic ground motion, then switch to the [[seismic_ground_motion_phenomenon\|Seismic groud motion phenomenon]], and you may need [[seimicLab_Plugin\|seismicLab Plugin]]. There are also many community-developed [[External_plugins\|external plugins]] available.		The plugin you will start using in LabRPS depends on the type random phenomenon you need to simulate: If you are going to work on random wind velocity, you'll probably want to try the [[windLab_Plugin\|windLab Plugin]]. If you will work on seismic ground motion, then switch to the [[seismic_ground_motion_phenomenon\|Seismic groud motion phenomenon]], and you may need [[seimicLab_Plugin\|seismicLab Plugin]]. There are also many community-developed [[External_plugins\|external plugins]] available.

LabRPS: /* Scripting */

2022-08-11T18:40:33Z

Scripting

← Older revision		Revision as of 11:40, 11 August 2022
Line 91:		Line 91:
	==Scripting==		==Scripting==

	And finally, one of the most powerful features of LabRPS is the [[~~scripting~~\|scripting]] environment. From the integrated scripting console, you can gain access to some part of LabRPS, create or modify RPS objecs.		And finally, one of the most powerful features of LabRPS is the [[MuParser\|scripting]] environment. From the integrated scripting console, you can gain access to some part of LabRPS, create or modify RPS objecs.

	== What's new ==		== What's new ==

LabRPS: Created page with "{{Docnav |Installing additional components |Mouse navigation }} {{TOCright}} ==Foreword== LabRPS is a computation tool for the numerical simulation of random phenomena. It is primarily made for researchers, but also serves all other who need to numerically reprent a random phenomenon without being involved with coding. LabRPS has been under development since 2015, and it offers a large list o..."

2022-08-11T18:38:23Z

Created page with "{{Docnav |Installing additional components |Mouse navigation }} {{TOCright}} ==Foreword== LabRPS is a computation tool for the numerical simulation of random phenomena. It is primarily made for researchers, but also serves all other who need to numerically reprent a random phenomenon without being involved with coding. LabRPS has been under development since 2015, and it offers a large list o..."

New page

{{Docnav
|[[Installing_additional_components|Installing additional components]]
|[[Mouse_navigation|Mouse navigation]]
}}

{{TOCright}}

==Foreword==

LabRPS is a computation tool for the [[About_LabRPS|numerical simulation of random phenomena]]. It is primarily made for researchers, but also serves all other who need to numerically reprent a random phenomenon without being involved with coding.

LabRPS has been under development since 2015, and it offers a large list of [[Feature_list|features]]. Capabilities are still missing but it is powerful enough for hobbyist use, and small workshops. There is a fast-growing community of enthusiastic users who participate in the [https://labrps.com/boards LabRPS forum], and you can find [https://labrps.com/boards many examples] of quality projects developed with LabRPS there.

Like all free software projects, LabRPS depends on its community to grow, gain features, and fix bugs. Don't forget this when using LabRPS; if you like it, you can [[Donate|donate]] and [[Help_LabRPS|help LabRPS]] in various ways, such as writing documentation.

See also:

* [[Tutorials|Tutorials]]
* [[Video_tutorials|Video tutorials]]

==Installing==

First of all, download and install LabRPS. See the [[Download|Download]] page for information on current versions and updates, and the installation instructions for you operating system ([[Installing_on_Windows|Windows]], [[Installing_on_Linux|Linux]] or [[Installing_on_Mac|Mac]]). There are install packages ready for Windows (.msi), Debian and Ubuntu (.deb), openSUSE (.rpm), and Mac OSX. LabRPS is available from the package managers of many other Linux distributions. A standalone [[AppImage|AppImage]] executable is also available, which will run on most recent 64-bit Linux systems. As LabRPS is open-source, you can also grab the source code and [[Compiling|compile]] it yourself.

==Exploring the interface==

[[File:LabRPS_interface_base_divisions.svg|1024px]]

{{Caption|The standard LabRPS interface}}

{{Emphasis|See a full explanation in [[Interface|Interface]].}}
:1. The [[main_view_area|main view area]], which can contain different tabbed windows.
:2. The [[graph_view|graph view]], showing the graphical representation of the simulation data or any data involved in the application.
:3. The [[spreadsheet_view|spreadsheet view]], showing the simulation data or any data involved in the application in the form of spreadsheet.
:4. The [[tree_view|tree view]] (part of the [[combo_view|combo view]]), showing the hierarchy.
:5. The [[property_editor|property editor]] (part of the [[combo_view|combo view]]), which allows viewing and modifying properties of the selected objects.
:6. The [[report_view|report view]] (or output window), where messages, warnings and errors are shown.
:7. The [[scripting_console|scripting console]], where you can enter [[MuParser|MuParser]] code.
:8. The [[result_log|result log]], where the simulation results, analysis results and informations are displayed.
:9. The [[project_explorer|project explorer]], where the content of the project document is displayed.
:10. The [[status_bar|status bar]], where some messages and tooltips appear.
:11. The toolbar area, where the toolbars are docked.
:12. The [[Std_Phenomenon|phenomenon selector]], where you select the active [[phenomena|phenomenon]].
:13. The [[Standard_Menu|standard menu]], which holds basic operations of the program.

The main concept behind the LabRPS interface is that it is separated into [[plugins|plugins]]. A plugin is a collection of tools suited for a specific task, such as working with [[PSD_decomposition|power spectrum matrix decomposition]], or computing the modulation function.

When you start LabRPS for the first time, you are presented with the Start page. Here is what it looks like for version 0.001:

[[File:Start_center_0.001_screenshot.png|600px]]

The Start page allows you to quickly jump to some parts of the application, open one of the recent files, or see the latest news from the LabRPS world. You can change the default phenomenon in the [[Std_Phenomenon|phenomenon selector]].

== Navigating in the 3D space ==

LabRPS has several [[Mouse_navigation|navigation modes]] available, that change the way you use your mouse to interact with the objects in the 3D view and the view itself.

==First steps with LabRPS==

LabRPS's focus is to allow you numerically generate random phenomena in an accuarate and realistic way, to allow researchers quicky developing new simulation tools. It is therefore very different from some other applications made for similar purposes. Its learning curve is make very short. If you are struck at some point, don't forget that the friendly community of users on the [https://labrps.com/boards LabRPS forum] might be able to get you out in no time.

The plugin you will start using in LabRPS depends on the type random phenomenon you need to simulate: If you are going to work on random wind velocity, you'll probably want to try the [[windLab_Plugin|windLab Plugin]]. If you will work on seismic ground motion, then switch to the [[seismic_ground_motion_phenomenon|Seismic groud motion phenomenon]], and you may need [[seimicLab_Plugin|seismicLab Plugin]]. There are also many community-developed [[External_plugins|external plugins]] available.

You can switch phenomenon at any time.

==Working with WindLab==
WindLab is a module in LabRPS that provides and manages all LabRPS's capabilities for the simulation of stochastic wind velocity. This module is automatically actived when wind velocity is selected in through the [[Std_Phenomenon|phenomenon selector]].
Don't confuse WindLab and windLab plugin. WindLab is LabRPS internal module providing the simulation framework of random wind velocity while windLab plugin is one of the plugin provided by LabRPS for simulation of random wind velocity.
This is a typical WindLab workflow:

# Define wind velocity direction (along wind, across wind, or vertical wind)
# Choose Wind type (stationary or non-stationary)
# Input the number of simulation locations
# Input the number time increments (the length of the simulated wind process)
# Select a spectrum model
# Choose a mean wind profile
# Choose a simulation method
# Choose a simulation mode (large scale simulation mode or not)
# Run the simulation

Which gives you the simulated wind velocity data like this:

[[Image:WindLab_example.jpg|600px]]

==Working with SeismicLab==
<coming soon>

==Working with SeaLab==
<coming soon>

==Scripting==

And finally, one of the most powerful features of LabRPS is the [[scripting|scripting]] environment. From the integrated scripting console, you can gain access to some part of LabRPS, create or modify RPS objecs.

== What's new ==

* See the [[Feature_list#Release_notes|release notes]] for the detailed list of features.

{{Docnav
|[[Installing_additional_components|Installing additional components]]
|[[Mouse_navigation|Mouse navigation]]
}}

{{Userdocnavi}}

[[Category:User Documentation]]