Debian Codegraph @

doc/features/advanced/instviewer.rst

raw
1 .. _ref-to-instviewer:
2
3 Installation and Configuration
4 ==============================
5
6 The **Installation and Configuration** dialog box is a diagnostic tool available from DataLab’s graphical interface. It provides a structured overview of the current installation, user-specific settings, and available plugins and I/O features.
7
8 This tool is primarily designed for troubleshooting and verification purposes — whether you are a user trying to understand how DataLab is set up on your system, or a developer validating your plugin integration.
9
10 To open the dialog box, go to the "?" menu in the main DataLab window and select **Installation and configuration**. This will open a dialog window that displays all relevant information about your DataLab installation.
11
12 The dialog window is divided into **three tabs**, each covering a specific aspect of the environment.
13
14 1. Installation Configuration
15 -----------------------------
16
17 .. figure:: /images/shots/instviewer.png
18
19 Installation and configuration (see "?" menu), tab 1
20
21 This tab displays system-level information about the DataLab installation, including:
22
23 - Application version;
24 - Platform and operating system;
25 - Whether DataLab is running in frozen (standalone) mode or as a standard Python package;
26 - Internal paths used for data storage and plugin discovery;
27 - Python interpreter details (version, architecture, paths);
28 - Location of the `datalab` package.
29
30 This section is especially useful for debugging path-related issues or confirming the installation context (e.g., standalone vs. pip-installed).
31
32 2. User Configuration
33 ---------------------
34
35 .. figure:: /images/shots/instviewer2.png
36
37 Installation and configuration (see "?" menu), tab 2
38
39 This tab lists user-specific configuration details, through the contents of DataLab's configuration file.
40
41 It helps users verify their personalized settings and ensures that DataLab is reading the correct directories for user-defined plugins or preferences.
42
43 3. Plugins and I/O Features
44 ---------------------------
45
46 .. figure:: /images/shots/instviewer3.png
47
48 Installation and configuration (see "?" menu), tab 3
49
50 This tab lists all plugins and I/O handlers currently available in the application.
51
52 This view is ideal for verifying that all expected plugins and I/O features are detected, loaded, and functional.
53
54 Usage Tips
55 ----------
56
57 - You can copy text from any of the tabs for diagnostic or support purposes.
58 - If a plugin or I/O feature does not appear, check that its filename starts with `datalab_` and that it is located in a recognized plugin directory (see the *User Configuration* tab).
59
60 .. note::
61
62 Reporting unexpected behavior or any other bug on `GitHub Issues`_ will be greatly appreciated, especially if the contents of this viewer are attached to the report (as well as log files, see :ref:`ref-to-logviewer`).
63
64 .. _GitHub Issues: https://github.com/DataLab-Platform/DataLab/issues/new/choose