Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
meisam committed Jan 23, 2023
1 parent c46305b commit 5c88e08
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -717,8 +717,8 @@ __ check_

13. **Something is not working! What should I do?**

* If you need help with compiling the code or running it on a cluster, please contact your `system administrator <https://en.wikipedia.org/wiki/System_administrator>`_.
* If you have found a bug in the code, please report it `here <https://github.com/MFTabriz/slabcc/issues/new>`__.
* If you need help with compiling the code or running it on a cluster, please contact your `system administrator <https://en.wikipedia.org/wiki/System_administrator>`_.
* If you have found a bug in the code, please report it `here <https://github.com/MFTabriz/slabcc/issues/new>`__.

==================================
Known issues and limitations
Expand Down
11 changes: 10 additions & 1 deletion readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Input parameters file for a slab should minimally include (all in relative scale

Example
--------
The following examples list the input parameters to be defined in `slabcc.in` file, assuming the VASP outputs (LOCPOT and CHGCAR files) to be in the same directory. Please read the `manual.html <http://htmlpreview.github.io/?https://github.com/MFTabriz/slabcc/blob/master/manual.html>`_ for complete list of the input parameters.
The following examples list the input parameters to be defined in `slabcc.in` file, assuming the VASP outputs (LOCPOT and CHGCAR files) to be in the same directory. Please read the `manual`_ for complete list of the input parameters.

1. **Minimum input**: The program models the extra charge with a Gaussian charge distribution localized around the position (``charge_position= 0.24 0.56 0.65``) in a slab model with normal direction of (``normal_direction = y``) and surfaces at (``interfaces = 0.25 0.75``). The dielectric tensor inside of the slab is assumed to be isotropic (``diel_in = 4.8``)::

Expand Down Expand Up @@ -173,14 +173,23 @@ We are trying to keep the slabcc compatible with as many compilers as possible b
The current version of the slabcc has been `build/validated <https://ci.codeberg.org/meisam/slabcc/branches/master>`_ on:

- Ubuntu Linux 16.04

- with GNU C/C++ compilers (5), OpenBLAS, FFTW

- Ubuntu Linux 18.04

- with GNU C/C++ compilers (8), OpenBLAS, FFTW

- Ubuntu Linux 22.04

- with GNU C/C++ compilers (9,11), OpenBLAS, FFTW

- AlmaLinux 8.7

- with GNU C/C++ compilers (8), BLAS, FFTW

- openSUSE Leap 15.4

- with GNU C/C++ compilers (10), BLAS, FFTW

==================================
Expand Down

0 comments on commit 5c88e08

Please sign in to comment.