Skip to content

Commit e618180

Browse files
committed
Add notes for stream file usage.
1 parent 9b16f8f commit e618180

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,13 @@ stream file for the perturbable molecule, or AMBER or GROMACS files for the two
6666
The format can be specified using the the `--output-format` option. If you require input
6767
for a free-energy perturbation simulation, e.g. a hybrid GROMACS toplogy file, the you can
6868
use the stream file with [BioSimSpace](https://biosimspace.openbiosim.org) to generate the
69-
required input files. Note that when a stream file is used as input, then the ouput will
70-
always be a stream file, regardless of the `--output-format` option.
69+
required input files.
70+
71+
> [!NOTE]
72+
> When a stream file is used as input, the `--mapping` option is ignored.
73+
74+
>[!NOTE]
75+
> When a stream file is used as inpput the output will always be a stream file,
76+
> regardless of the `--output-format` option.
7177
7278
Please run `ghostly --help` for more details of other configuration options.

0 commit comments

Comments
 (0)