User hub: Difference between revisions

Latest revision as of 17:29, 28 October 2024

This is the main help area for newcomers to LabRPS.

LabRPS is in continuous development, so there may be missing or outdated information. If you cannot find the information that you need, don't hesitate to ask in the LabRPS forum.

If you'd like to contribute to LabRPS, please donate, and see the Help LabRPS page for other ways to contribute. If you'd like to edit this wiki, request a wiki account with editor permissions in the forum, and read the WikiPages for the general guidelines that you should follow.

If you would like to know how LabRPS started years ago visit the History page.

Using LabRPS

Introduction

Application Overview: A general overview of LabRPS
Installing: How to install LabRPS on Windows, Linux and Mac
Installing additional components: how to install additional third-party components that can work together with LabRPS.
Getting started: A quick overview of the available tools
FAQ: Frequently asked questions
Tutorials covering different parts of LabRPS

Basic application

Interface: the LabRPS interface is composed of various graphical elements on the screen, including the dependency graph view, the tree view, the property editor, the task panel, and the Python console.
Objects naming: LabRPS objects have a read-only Name that uniquely identifies them, and a Label which is user editable.
Preferences Editor: the system that allows you to control many properties of the base system and of the individual workbenches.

Plugins

Plugins are collections of tools used for specific tasks. These are the base plugins bundled with every LabRPS installation:

The WindLab Plugin provides a set of tools for the simulation of random wind velocity.

The SeismicLab Plugin provides a set of tools for the simulation of seismic ground motion.

The SeaLab Plugin provides a set of tools for the simulation of sea surface.

External plugins

External plugins are collections of functions that are not part of the base LabRPS system, usually developed by experienced users, and targeting a particular need.

Plugins can be installed using the Addon Manager or the Feature Manager.

Reference

Commands Reference: A complete list of the available LabRPS commands.

Online Help

This is the official LabRPS online help. The whole online help system will be used to generate a .CHM file, that will be distributed with the binary packages of LabRPS. At the moment the online help summarizes some of the most complete sections of this wiki.

Online help system - Table of Contents

More

The Power users hub is the place to go if you would like to see more advanced use of LabRPS
Don't understand a term or phrase as used in LabRPS? Try the Glossary page.

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

Addons: Addon Manager, Plugins, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 24: / Line 24: @@
 ===Basic application===
-* [[Interface|Interface]]: the LabRPS interface is composed of various graphical elements on the screen, including the [[3D_graph_view|3D graph view]], [[2D_graph_view|2D graph view]], the [[Table_view|table view]], the [[Matrix_view|matrix view]], the [[Visual_objects_tree_view|visual object tree view]], the [[RPS_objects_tree_view|rps object tree view]], the [[Visual_objects_property_editor|Visual object property editor]], the [[RPS_objects_property_browser|RPS object property browser]], the [[Project_explorer|project explorer]], the [[Result_log|result log]], and the [[Scripting_console|scripting console]].
+* [[Interface|Interface]]: the LabRPS interface is composed of various graphical elements on the screen, including the [[Dependency_graph_view|dependency graph view]], the [[Tree_view|tree view]], the [[Property_editor|property editor]], the [[Task_panel|task panel]], and the [[Python_console|Python console]].
-* [[Mouse_navigation|Mouse navigation]]: the different types of using the mouse to navigate in the view.
+* [[Object_name|Objects naming]]: LabRPS objects have a read-only {{incode|Name}} that uniquely identifies them, and a {{incode|Label}} which is user editable.
-* [[Selection_methods|Selection methods]]: the different methods of selecting in the software.
+* [[Preferences_Editor|Preferences Editor]]: the system that allows you to control many properties of the base system and of the individual workbenches.
-* [[Preferences_Editor|Preferences Editor]]: the system that allows you to control many properties of the base system and of the individual plugins.
-* [[Import_Export|File formats]]: the different file formats that LabRPS can read and write.
 ===Plugins===
@@ Line 35: / Line 33: @@
 <!--Please keep this list consistent with Online_Help_Toc and Plugins-->
-* [[Image:Labrps.svg|32px]] [[Std_Base|Standard tools]]. These commands and tools are present in all plugins.
+* [[Image:Workbench_WindLab.svg|32px]] The [[WindLab_Plugin|WindLab Plugin]] provides a set of tools for the simulation of random wind velocity.
-* [[Image:Plugin_Start.svg|32px]] The [[Start_Plugin|Start Center Plugin]] allows you to quickly jump to one of the most common plugins.
+* [[Image:Workbench_SeismicLab.svg|32px]] The [[SeismicLab_Plugin|SeismicLab Plugin]] provides a set of tools for the simulation of seismic ground motion.
+* [[Image:Workbench_SeaLab.svg|32px]] The [[SeaLab_Plugin|SeaLab Plugin]] provides a set of tools for the simulation of sea surface.
 ===External plugins===
-When many macros or functions are developed together, and are organized in toolbars and menus, they can become a new plugin.
 [[External_plugins|External plugins]] are collections of functions that are not part of the base LabRPS system, usually developed by experienced users, and targeting a particular need.
-Plugins can be installed using the [[Std_Plugin|Plugin Manager]]. For additional installation see [[How_to_install_additional_plugins|How to install additional plugins]].
+Plugins can be installed using the [[Std_AddonMgr|Addon Manager]] or the [[Std_DlgRPSFeatures|Feature Manager]].
 ==Reference==
@@ Line 59: / Line 56: @@
 * The [[Power_users_hub|Power users hub]] is the place to go if you would like to see more advanced use of LabRPS
-* The [[LabRPS_Community_Portal|LabRPS Community Portal]] lists projects made by community members around LabRPS.
 * Don't understand a term or phrase as used in LabRPS?  Try the [[Glossary|Glossary]] page.