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: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ The standard way of installing `ppafm` is:
26
26
pip install ppafm
27
27
```
28
28
29
-
This should install the package and all its dependencies including **CPU**and **GPU**version and fully working CLI:
29
+
This should install the package and all its dependencies including **CPU** version and fully working CLI:
30
30
31
31
The most up-to-date installation guide can be found on the [dedicated wiki page](https://github.com/Probe-Particle/ppafm/wiki/Install-ppafm).
32
32
@@ -42,11 +42,12 @@ ppafm-generate-ljff -h
42
42
43
43
For more information, please consult the [dedicated page](https://github.com/Probe-Particle/ppafm/wiki/Command-line-interface) on the command line interface of `ppafm`.
44
44
45
-
## Graphical User Interface (GUI)
46
-
The package comes with a convenient graphical user interface.
47
-
Unlike CLI, this interface needs to be explicitly enabled during the installation.
45
+
## GPU version and Graphical User Interface (GUI)
46
+
The package comes with a **GPU** speedup version and convenient graphical user interface.
47
+
Unlike CLI, these needs to be explicitly enabled during the installation.
48
48
To enable it, check the [dedicated section](https://github.com/Probe-Particle/ppafm/wiki/Install-ppafm#enable-gpugui-support) on the [Install ppafm](https://github.com/Probe-Particle/ppafm/wiki/Install-ppafm#enable-gpugui-support) wiki page.
49
49
To know more about the GUI interface, please consult the [ppafm GUI](https://github.com/Probe-Particle/ppafm/wiki/PPAFM-GUI) wiki page.
50
+
Additional information about the **GPU** version can be found [bellow](https://github.com/Probe-Particle/ppafm?tab=readme-ov-file#run-gpu-generator-for-machine-learning), at [models](https://github.com/Probe-Particle/ppafm/wiki#ppafm-simulation-models-and-implementations) and [models differences](https://github.com/Probe-Particle/ppafm/wiki/Differences-between-the-CPU-and-GPU-implementations) wiki pages.
50
51
51
52
## Usage examples
52
53
@@ -88,3 +89,4 @@ If you have used `ppafm` in your research, please cite the following articles:
0 commit comments