Skip to content

Commit 7ad074a

Browse files
authored
Clarify GPU support and GUI installation in README
Updated README to clarify GPU version and installation requirements.
1 parent f14cca7 commit 7ad074a

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The standard way of installing `ppafm` is:
2626
pip install ppafm
2727
```
2828

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:
3030

3131
The most up-to-date installation guide can be found on the [dedicated wiki page](https://github.com/Probe-Particle/ppafm/wiki/Install-ppafm).
3232

@@ -42,11 +42,12 @@ ppafm-generate-ljff -h
4242

4343
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`.
4444

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.
4848
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.
4949
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.
5051

5152
## Usage examples
5253

@@ -88,3 +89,4 @@ If you have used `ppafm` in your research, please cite the following articles:
8889

8990
## License
9091
MIT
92+

0 commit comments

Comments
 (0)