You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+23-6
Original file line number
Diff line number
Diff line change
@@ -56,26 +56,42 @@ $ gorder YOUR_INPUT_YAML_FILE
56
56
## Validation
57
57
58
58
### Atomistic order parameters
59
-
🏗️ Work in progress... 🏗️
59
+
A CHARMM36m simulation of a membrane consisting of 256 lipids was used to validate the calculation of atomistic order parameters by the `gorder` program. In total, the system contained ~64,500 atoms. The trajectory was 200 ns long and consisted of 10,000 frames. The following programs were used for validation:
60
+
- [`OrderParameter.py` by NMR Lipids](https://github.com/NMRLipids/Databank/blob/main/Scripts/AnalyzeDatabank/calcOrderParameters.py)
We also present a comparison of the calculated order parameters with the results from `gmx order`. Note that `gmx order` actually calculates united atom order parameters, so it is not suitable for atomistic systems. (However, many users still utilize it.)
64
+
65
+

66
+
67
+
*All programs, except for `gmx order`, produce the same results. Minor variations due to different calculation approaches are too small to be visible in the chart. `gmx order` returns slightly different values (and no value for carbon #16) because it calculates united atom, not atomistic, order parameters.*
60
68
61
69
### Coarse-grained order parameters
62
-
A Martini 3 simulation of a membrane consisting of 512 POPC lipids was used to validate the `gorder` program. In total, the system contained ~16,800 beads. The trajectory had a length of 1 μs and consisted of 10,000 frames. The following programs/libraries were used for validation:
70
+
A Martini 3 simulation of a membrane consisting of 512 POPC lipids was used to validate the calculation of CG order parameters by the `gorder` program. In total, the system contained ~16,800 beads. The trajectory had a length of 1 μs and consisted of 10,000 frames. The following programs/libraries were used for validation:

68
76
69
-
*Yes, all programs returned the same results. Minor variations due to the employed calculation approaches are too small to be visible in the chart.*
77
+
*All programs produce the same results. Minor variations due to the employed calculation approaches are too small to be visible in the chart.*
70
78
71
79
## Benchmarking
72
-
> **tl;dr `gorder` is fast. Like *really* fast.**
80
+
### Atomistic order parameters
81
+
Run time of the analyses performed in the Validation section by various programs:
82
+

83
+
84
+
*Benchmarks were conducted on Debian 12 with an 8-core Intel Core i7-10700 CPU. Benchmarking of `gmx order` and `gorder` was performed using [`hyperfine`](https://github.com/sharkdp/hyperfine). The `NMR lipids` script and `calc_op.tcl` were dramatically slower, so only approximate values obtained using GNU's `time` are reported.*
85
+
86
+
<sup>a</sup> Note that, unlike `calc_op.tcl` and `gmx order`, the NMR lipids script provides information about the order of individual C-H bonds. `gorder` also provides this information.
87
+
88
+
<sup>b</sup> Note that `gmx order` calculates united atom order parameters, not atomistic order parameters. For saturated tails, this calculation is reasonably accurate; however, for unsaturated tails, it is **very** inaccurate [[1]](https://doi.org/10.1021/acs.jctc.7b00643). Additionally, it is slower and more tedious to use than `gorder`, so there is little justification for using it for atomistic systems.
73
89
74
90
### Coarse-grained order parameters
75
91
Run time of the analyses performed in the Validation section by various programs:
76
92

77
93
78
-
*Benchmarks were run on 8-core Intel Core i7-10700 CPU. Benchmarking of `order` and `gorder` was performed using [`hyperfine`](https://github.com/sharkdp/hyperfine). `do-order` and `lipyphilic` were really slow, so only an approximate value obtained using GNU's `time` is reported.*
94
+
*Benchmarks were conducted on Debian 12 with with an 8-core Intel Core i7-10700 CPU. Benchmarking of `order` and `gorder` was performed using [`hyperfine`](https://github.com/sharkdp/hyperfine). `do-order` and `lipyphilic` were dramatically slower, so only an approximate value obtained using GNU's `time` is reported.*
79
95
80
96
<sup>a</sup> Note that the `do-order` script is not able to calculate order parameters for individual leaflets in the same run. In contrast, both `order` and `gorder` were run with this capability enabled.
81
97
@@ -88,4 +104,5 @@ Run time of the analyses performed in the Validation section by various programs
88
104
The command line tool and the crate are both released under the MIT License.
89
105
90
106
## Limitations
91
-
Only works for simulations with orthogonal simulation boxes.
107
+
- `gorder` only works for simulations with orthogonal simulation boxes.
108
+
- `gorder` is developed on Linux for Linux. While it should work on other operating systems, it is not guaranteed.
0 commit comments