You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.rst
+35-1Lines changed: 35 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,44 @@ PhysPlot: Advanced Plotting Made Simple
4
4
.. image:: _static/PhysPlotWide.png
5
5
:alt:PhysPlot logo
6
6
:align:center
7
-
:width:420px
7
+
:width:620px
8
8
9
9
PhysPlot is a scientific plotting software with a graphical user interface, designed to produce publication-ready 2D plots. It supports vector and bitmap outputs and allows importing, transforming, plotting, fitting, and exporting datasets.
10
10
11
+
Branding
12
+
--------
13
+
14
+
PhysPlot documentation uses the official wide brand asset ``_static/PhysPlotWide.png`` on the home page and follows the project trademark policy for name and logo usage.
15
+
16
+
Plugin System
17
+
-------------
18
+
19
+
PhysPlot supports plugin-based extension points for importing, transforming, and fitting data without editing core GUI files.
20
+
21
+
File Loader plugins
22
+
~~~~~~~~~~~~~~~~~~~
23
+
24
+
- Add ``.py`` files to ``fileloader/`` with ``title`` and ``load_data(file_path)``.
25
+
- The default loader keeps CSV/XLSX/TXT/TSV support.
26
+
- Loaders are auto-discovered and appear in both:
27
+
28
+
- **Settings > File Loader**
29
+
- The **Data Loader** dropdown above **Import Data**
30
+
31
+
Transform Function plugins
32
+
~~~~~~~~~~~~~~~~~~~~~~~~~~
33
+
34
+
- Add ``.py`` files to ``functions/`` with ``DISPLAY_NAME``, ``DEFAULT_LABEL``, and ``transform(values)``.
35
+
- Built-in transform categories include identity, powers, reciprocal, logarithmic, exponential, and trigonometric operations.
36
+
- Functions are auto-discovered and shown in the top-bar **Functions** menu and transform dropdown.
37
+
38
+
Curve-Fitting plugins
39
+
~~~~~~~~~~~~~~~~~~~~~
40
+
41
+
- Add ``.py`` files to ``curvefitting/`` for polynomial or callable models.
42
+
- Files are discovered at startup and shown in the curve-fit configuration list.
43
+
- Use this for custom equations and domain-specific fitting workflows.
0 commit comments