Skip to content

Commit 043ea25

Browse files
committed
restore --outfile argument with JSON filename-only description
1 parent 93077c6 commit 043ea25

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

CodeEntropy/config/arg_config_manager.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,14 @@
6868
"action": "store_true",
6969
"help": "Enable verbose output",
7070
},
71+
"output_file": {
72+
"type": str,
73+
"help": (
74+
"Name of the output file to write results to (filename only). Defaults "
75+
"to output_file.json"
76+
),
77+
"default": "output_file.json",
78+
},
7179
"force_partitioning": {"type": float, "help": "Force partitioning", "default": 0.5},
7280
"water_entropy": {
7381
"type": bool,

docs/getting_started.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,10 @@ The ``top_traj_file`` argument is required; other arguments have default values.
162162
- Enable verbose output.
163163
- ``False``
164164
- ``bool``
165+
* - ``--outfile``
166+
- Name of the JSON output file to write results to (filename only). Defaults to ``outfile.json``.
167+
- ``outfile.json``
168+
- ``str``
165169
* - ``--force_partitioning``
166170
- Factor for partitioning forces when there are weak correlations.
167171
- ``0.5``

0 commit comments

Comments
 (0)