Skip to content

Commit f40bfb2

Browse files
committed
update readme
1 parent 26148e5 commit f40bfb2

File tree

1 file changed

+46
-12
lines changed

1 file changed

+46
-12
lines changed

README.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# Angular Scan
1+
<p align="center">
2+
<img src="assets/duello-logo.png" alt="crates.io", height="200">
3+
</p>
4+
<p align="center">
5+
<a href="https://opensource.org/licenses/Apache-2.0">
6+
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg">
7+
</a>
8+
</p>
9+
10+
-----
11+
12+
<p align = "center">
13+
<b>Duello</b></br>
14+
<i>Virial Coefficient and Dissociation Constant Estimation for Rigid Macromolecules</i>
15+
</p>
16+
17+
-----
18+
19+
# Introduction
220

321
This iterates over all intermolecular poses between two rigid molecules.
422
For each pose, defined by two quaternions and a mass center separation, the
@@ -11,36 +29,52 @@ the thermally averaged energy, $u(r) = \sum u(r)e^{-\beta u(r)} / Q$.
1129

1230
![Angular Scan](assets/illustration.png)
1331

14-
## Usage
32+
# Installation
33+
34+
```console
35+
pip install duello
36+
```
37+
38+
# Usage
1539

1640
The command-line tool `duello` does the 6D scanning and calculates
17-
the potential of mean force, w(r) which
41+
the potential of mean force, _w(r)_ which
1842
is used to derive the 2nd virial coefficient and twobody dissociation constant.
19-
Two input structures are requires (`.xyz` format) and all particle types must
43+
The two input structures should be in `.xyz` format and all particle names must
2044
be defined in the topology file.
21-
The topology files also defines the particular pair-potential to use.
45+
The topology also defines the particular pair-potential to use.
2246
Note that currently, a coulomb potential is automatically added and should
23-
hence not be specified in the topology.
47+
hence _not_ be specified in the topology.
2448

2549
```console
26-
duello scan --icotable -1 cppm-p18.xyz -2 cppm-p00.xyz --rmin 40.5 --rmax 60 --dr 1.0 --top topology.yaml --resolution 0.6 --molarity 0.05
50+
duello scan \
51+
--icotable \
52+
--mol1 cppm-p18.xyz \
53+
--mol2 cppm-p18.xyz \
54+
--rmin 37 --rmax 50 --dr 0.5 \
55+
--top topology.yaml \
56+
--resolution 0.8 \
57+
--cutoff 1000 \
58+
--molarity 0.05 \
59+
--temperature 298.15
2760
```
2861

29-
### Examples
62+
The program is written in Rust and attempts to use all available CPU cores.
63+
64+
## Examples
3065

31-
See the `examples/` directory for examples; run scripts are provided in the
32-
`scripts/` directory:
66+
Ready run scripts examples are provided in the `scripts/` directory:
3367

3468
Command | Description
3569
--------------------- | ------------------------------------------------------------
3670
`scripts/cppm.sh` | Spherical, multipolar particles using the CPPM model
3771
`scripts/lysozyme.sh` | Two coarse grained lysozyme molecules w. Calvados3 interactions
3872

39-
## Development
73+
# Development
4074

4175
This is for development purposes only.
4276

43-
### Create `pip` package using Maturin
77+
## Create `pip` package using Maturin
4478

4579
```console
4680
pip install ziglang pipx

0 commit comments

Comments
 (0)