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: docs/getting_started.rst
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,8 +71,8 @@ The top_traj_file argument is necessary to identify your simulation data, the ot
71
71
- Default
72
72
- Type
73
73
* - ``--top_traj_file``
74
-
- Path to Structure/topology file(``AMBER PRMTOP``, ``GROMACS TPR`` or topology file with MDAnalysis readable dihedral information (not officially supported)) followed by Trajectory file(s) (``GROMAC TRR`` or ``AMBER NETCDF``) You will need to output the **coordinates** and **forces** to the **same file** .
75
-
- Required
74
+
- Path to Structure/topology file followed by Trajectory file(s). Any MDAnalysis readable files should work (for example ``GROMACS TPR and TRR`` or ``AMBER PRMTOP and NETCDF``). You will need to output the **coordinates** and **forces** to the **same file** .
75
+
- Required, no default value
76
76
- list of ``str``
77
77
* - ``--selection_string``
78
78
- Selection string for CodeEntropy such as protein or resid, refer to ``MDAnalysis.select_atoms`` for more information.
@@ -102,10 +102,6 @@ The top_traj_file argument is necessary to identify your simulation data, the ot
102
102
- Enable verbose output
103
103
- ``False``
104
104
- ``bool``
105
-
* - ``--thread``
106
-
- How many multiprocess to use.
107
-
- ``1``: for single core execution
108
-
- ``int``
109
105
* - ``--outfile``
110
106
- Name of the file where the text format output will be written.
111
107
- ``outfile.out``
@@ -118,6 +114,10 @@ The top_traj_file argument is necessary to identify your simulation data, the ot
118
114
- Use Jas Kalayan's waterEntropy code to calculate the water conformational entropy
119
115
- ``False``
120
116
- ``bool``
117
+
* - ``--grouping``
118
+
- How to group molecules for averaging
119
+
- ``molecules``
120
+
- ``str``
121
121
122
122
123
123
Example #1
@@ -147,3 +147,4 @@ To use the same settings as in Example #1, but override trajectory information,
147
147
Or as an alternative, you could edit the config.yaml file and use the CodeEntropy command as in the first example.
148
148
149
149
CodeEntropy creates job* directories for the output, where * is a job number choosen by the so that there are sequentially numbered directories when you rerun CodeEntropy in the same working directory.
150
+
Each job* directory contains the output json file and a subdirectory with the log files.
0 commit comments