Getting started: Difference between revisions

From LabRPS Documentation
Jump to navigation Jump to search
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Docnav
{{Docnav
|[[Installing_additional_components|Installing additional components]]
|[[Installing_on_Mac|Installing on Mac]]
|[[Mouse_navigation|Mouse navigation]]
|[[Document_structure|Document structure]]
}}
}}


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.
Line 25: Line 28:
==Exploring the interface==  
==Exploring the interface==  


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


{{Caption|The standard LabRPS interface}}
{{Caption|The standard LabRPS interface}}
Line 31: Line 34:
{{Emphasis|See a full explanation in [[Interface|Interface]].}}
{{Emphasis|See a full explanation in [[Interface|Interface]].}}
:1. The [[main_view_area|main view area]], which can contain different tabbed windows.
: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.
:2. The [[Dependency_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.
:3. The [[combo_view|combo view]] ([[tree_view|tree view]], [[task_panel|task panel]] and [[property_editor|property editor]]), showing the hierarchy and construction history of objects in the document and also allow the user to run tasks for active commands.
:4. The [[tree_view|tree view]] (part of the [[combo_view|combo view]]), showing the hierarchy.
:4. The [[selection_view|selection view]], which indicates the objects or sub-elements of objects that are selected.
:5. The [[property_editor|property editor]] (part of the [[combo_view|combo view]]), which allows viewing and modifying properties of the selected objects.
:5. The [[report_view|report view]] (or output window), where messages, warnings and errors are shown.
:6. The [[report_view|report view]] (or output window), where messages, warnings and errors are shown.
:6. The [[Python_console|Python console]], where all the commands executed are printed, and where you can enter [[Python|Python]] code.
:7. The [[scripting_console|scripting console]], where you can enter [[MuParser|MuParser]] code.
:7. The [[Plot_explorer|project explorer]], shows all tables, matrices and plots created in the application.
:8. The [[result_log|result log]], where the simulation results, analysis results and informations are displayed.
:8. The [[Pesult_view|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.
:9. The [[status_bar|status bar]], where some messages and tooltips appear.
:10. The [[status_bar|status bar]], where some messages and tooltips appear.
:10. The [[Plot_editor|plot property editor]], allows viewing and modifying properties of the items such as tables, matrices and plots in the active view.
:11. The toolbar area, where the toolbars are docked.
:11. The [[Standard_Menu|standard menu]], which holds basic operations of the program.
:12. The [[Std_Phenomenon|phenomenon selector]], where you select the active [[phenomena|phenomenon]].
:12. The toolbar area, where the toolbars are docked.
:13. The [[Standard_Menu|standard menu]], which holds basic operations of the program.
:13. The [[Std_Workbench|workbench selector]], where you select the active [[workbenches|workbench]].


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.
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]].
 
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]].
 
== Navigation style ==
 
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 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.
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 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.
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 wind velocity is selected in through the [[Std_Phenomenon|phenomenon selector]].
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.  
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:
This is a typical WindLab workflow:


# Define wind velocity direction (along wind, across wind, or vertical wind)
# Create new [[WindLab_New|wind velocity simulation]]
# Choose Wind type (stationary or non-stationary)
# Edit the properties of newly created wind velocity simulation to switch your need.
# Input the number of simulation locations
# Create new [[WindLab_NewFeature|WindLab feature]] (simulation points, mean wind profile, wind spectrum, etc.)
# Input the number time increments (the length of the simulated wind process)
# Right click on the created feature in the [[tree_view|tree view]] and select action to run the feature and show computation results.
# 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==
{{VeryImportantMessage|Section TBD}}
 
==Working with SeaLab==
{{VeryImportantMessage|Section TBD}}


==Scripting==  
==Scripting==  


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.
And finally, one of the most powerful features of LabRPS is the [[Power_users_hub#Scripting_in_LabRPS|scripting]] environment. From the integrated python console (or from any other external Python script), you can gain access to almost any part of LabRPS, create or modify RPS features or access and modify the LabRPS interface. Python scripting can also be used in [[macros|macros]], which provide an easy method to create custom commands.
 
== What's new ==
 
* See the [[Feature_list#Release_notes|release notes]] for the detailed list of features.




{{Docnav
{{Docnav
|[[Installing_additional_components|Installing additional components]]
|[[Installing_on_Mac|Installing on Mac]]
|[[Mouse_navigation|Mouse navigation]]
|[[Document_structure|Document structure]]
}}
}}


Latest revision as of 09:00, 29 October 2024

Arrow-left.svg Previous: Installing on Mac

Foreword

LabRPS is a computation tool for the 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:

  1. Stochastic wind velocity
  2. Seismic ground motion
  3. Sea surface

LabRPS has been under development since 2015, and it offers a large list of 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 LabRPS forum, and you can find 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 and help LabRPS in various ways, such as writing documentation.

See also:

Installing

First of all, download and install LabRPS. See the Download page for information on current versions and updates, and the installation instructions for you operating system (Windows, Linux or 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 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 compile it yourself.

Exploring the interface

LabRPS interface base divisions.png

The standard LabRPS interface

See a full explanation in Interface.

1. The main view area, which can contain different tabbed windows.
2. The graph view, showing the graphical representation of the simulation data or any data involved in the application.
3. The combo view (tree view, task panel and property editor), showing the hierarchy and construction history of objects in the document and also allow the user to run tasks for active commands.
4. The selection view, which indicates the objects or sub-elements of objects that are selected.
5. The report view (or output window), where messages, warnings and errors are shown.
6. The Python console, where all the commands executed are printed, and where you can enter Python code.
7. The project explorer, shows all tables, matrices and plots created in the application.
8. The result log, where the simulation results, analysis results and informations are displayed.
9. The status bar, where some messages and tooltips appear.
10. The plot property editor, allows viewing and modifying properties of the items such as tables, matrices and plots in the active view.
11. The standard menu, which holds basic operations of the program.
12. The toolbar area, where the toolbars are docked.
13. The workbench selector, where you select the active workbench.

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.

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 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. If you are going to work on seismic ground motion, then switch to the SeismicLab Workbench.

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. Don't confuse WindLab and WindLab Plugin. WindLab, also called WindLab Workbench is LabRPS internal module providing the simulation framework of random wind velocity while WindLab Plugin is one of the offical plugins provided by LabRPS for simulation of random wind velocity. This is a typical WindLab workflow:

  1. Create new wind velocity simulation
  2. Edit the properties of newly created wind velocity simulation to switch your need.
  3. Create new WindLab feature (simulation points, mean wind profile, wind spectrum, etc.)
  4. Right click on the created feature in the tree view and select action to run the feature and show computation results.

Scripting

And finally, one of the most powerful features of LabRPS is the scripting environment. From the integrated python console (or from any other external Python script), you can gain access to almost any part of LabRPS, create or modify RPS features or access and modify the LabRPS interface. Python scripting can also be used in macros, which provide an easy method to create custom commands.


Arrow-left.svg Previous: Installing on Mac
User hub.png User documentation
Retrieved from "https://wiki.labrps.com/index.php?title=Getting_started&oldid=2141"