Skip to content

Commit 6d8ef73

Browse files
committed
rename examples
1 parent 4e008bc commit 6d8ef73

File tree

5 files changed

+25
-4
lines changed

5 files changed

+25
-4
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,31 @@ duello scan \
8787

8888
Ready run scripts examples are provided in the `scripts/` directory:
8989

90-
Command | Description
91-
--------------------- | ------------------------------------------------------------
92-
`scripts/cppm.sh` | Spherical, multipolar particles using the CPPM model
93-
`scripts/lysozyme.sh` | Two coarse grained lysozyme molecules w. Calvados3 interactions
90+
Command | Description
91+
---------------------- | ------------------------------------------------------------
92+
`scripts/cppm.sh` | Spherical, multipolar particles using the CPPM model
93+
`scripts/calvados3.sh` | Two coarse grained lysozyme molecules w. Calvados3 interactions
94+
95+
## Interaction models
96+
97+
Each macromolecule is represented by a rigid constellation of beads with
98+
properties defined under `atoms` in the topology file.
99+
The inter-molecular energy is calculated by summing all pairwise interactions
100+
between beads using a customizable pair potential.
101+
If needed, different pair-potentials can be explicitly defined for
102+
specific atom pairs.
103+
104+
The provided examples illustrate the following schemes:
105+
106+
- Screened `Coulomb` + `AshbaughHatch`, for the Calvados model.
107+
- Screened `Coulomb` + `WeeksChandlerAndersen` for the CPPM model.
108+
109+
Many more pair-potentials are available through the
110+
[`interatomic`](https://crates.io/crates/interatomic) library,
111+
_e.g._ `LennardJones`, `HardSphere` etc.
112+
113+
__Warning:__ The electrostatic term, `Coulomb` is
114+
always automatically added and should therefore _not_ be specified in the topology.
94115

95116
# Development
96117

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
Β (0)