Skip to content

Commit

Permalink
up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lmiq committed Apr 29, 2022
1 parent 2d94084 commit 277a451
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ one atom within a distance from a solute.

Currently only works with Gromacs topology and trajectory formats.

The calculations run in parallel if `julia` is initialized with multi-threading support, i. e. with `julia -t auto`, for example.

## Installation

```julia
Expand Down Expand Up @@ -66,9 +68,11 @@ Three keyword arguments can be passed to the `electrostatic_potential` function:

| keyword | values | default | meaning |
|:-------------:|:---------------:|:--:|:-------------|
| `show_progress` | `true/false` | `true` | Display or not the progress bar. |
| `standard_cutoff` | `true/false` | `false` |Use a standard cutoff, and thus no interaction above the cutoff distance will be considered. |
| `shift` | `true/false` | `false` | Use a shifting function, as described [here](https://www.ks.uiuc.edu/Research/namd/2.10/ug/node23.html). |
| `show_progress` | `true/false` | `true` | Display or not the progress bar. |

Note that with `standard_cutoff` and/or `shift` turned on, the calculation is not particularly interesting, as it does not represent anymore the interaction of the complete molecules that have at least one atom within the desired distance range. These options are mostly used for testing purposes.

## Related work:

Expand Down

0 comments on commit 277a451

Please sign in to comment.