Skip to content

Commit b32f199

Browse files
committed
updating input arguments in docs
1 parent 266391b commit b32f199

3 files changed

Lines changed: 13 additions & 12 deletions

File tree

docs/community_guide.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ To run the full test suite, simply install ``pytest`` and run in root directory
2626
2727
pytest
2828
29-
To only run the unit tests in a particular part of program. For example only running test for solute part.
29+
To only run the unit tests in a particular part of program, for example only running tests for the levels functions:
3030

3131
.. code-block:: bash
3232
33-
pytest CodeEntropy/tests/test_CodeEntropy.py
33+
pytest CodeEntropy/tests/test_CodeEntropy/test_levels.py
3434
3535
36-
To only run the a specific test. e.g.
36+
To only run the a specific test, e.g.:
3737

3838
.. code-block:: bash
3939
40-
pytest CodeEntropy/tests/test_CodeEntropy.py::test_CodeEntropy_parser_labForces
40+
pytest CodeEntropy/tests/test_CodeEntropy/test_levels.py::test_select_levels

docs/config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
run1:
44
top_traj_file: ["1AKI_prod.tpr", "1AKI_prod.trr"]
5-
selection_string: 'not water'
5+
selection_string: 'all'
66
start: 0
77
end: 500
88
step: 1
99
bin_width: 30
1010
temperature: 300
1111
verbose: True
12-
thread:
1312
force_partitioning: 0.5
1413
water_entropy: False
14+
grouping: 'molecules'

docs/getting_started.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ The top_traj_file argument is necessary to identify your simulation data, the ot
7171
- Default
7272
- Type
7373
* - ``--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
7676
- list of ``str``
7777
* - ``--selection_string``
7878
- 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
102102
- Enable verbose output
103103
- ``False``
104104
- ``bool``
105-
* - ``--thread``
106-
- How many multiprocess to use.
107-
- ``1``: for single core execution
108-
- ``int``
109105
* - ``--outfile``
110106
- Name of the file where the text format output will be written.
111107
- ``outfile.out``
@@ -118,6 +114,10 @@ The top_traj_file argument is necessary to identify your simulation data, the ot
118114
- Use Jas Kalayan's waterEntropy code to calculate the water conformational entropy
119115
- ``False``
120116
- ``bool``
117+
* - ``--grouping``
118+
- How to group molecules for averaging
119+
- ``molecules``
120+
- ``str``
121121

122122

123123
Example #1
@@ -147,3 +147,4 @@ To use the same settings as in Example #1, but override trajectory information,
147147
Or as an alternative, you could edit the config.yaml file and use the CodeEntropy command as in the first example.
148148

149149
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

Comments
 (0)