From ab2158fb3f8053c6277113b4fb22007859f53de8 Mon Sep 17 00:00:00 2001 From: Thomas White Date: Mon, 29 Mar 2021 15:21:00 +0200 Subject: Add documentation for --harvest-file --- doc/man/indexamajig.1 | 6 ++++++ doc/man/partialator.1 | 5 +++++ 2 files changed, 11 insertions(+) (limited to 'doc') diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1 index f94bec01..44f46c18 100644 --- a/doc/man/indexamajig.1 +++ b/doc/man/indexamajig.1 @@ -536,6 +536,12 @@ Do not record integrated reflections in the stream. The resulting output won't .PD Start the serial numbers in the stream at \fIn\fR instead of 1. Use this if you are splitting an indexing job up into several smaller ones, so that the streams can be concatenated into a single one with consistent numbering. This is important if you use \fBwhirligig\fR. +.PD 0 +.IP \fB--harvest-file=\fIfn\fR +.PD +Write a list of parameters to \fIfn\fR, in JSON format. This is intended to be used for harvesting data into a database system. This option has no effect if --serial-offset is set to a number larger than 1, to avoid the file being overwritten multiple times in a batch system. + + .SH HISTORICAL OPTIONS .PD 0 diff --git a/doc/man/partialator.1 b/doc/man/partialator.1 index 601a2c44..fe1e0207 100644 --- a/doc/man/partialator.1 +++ b/doc/man/partialator.1 @@ -182,6 +182,11 @@ If you prefer, you can specify the ambiguity operator by specifying the apparent .PD Set the X-ray bandwidth, initial profile radius or wavelength for all crystals before proceeding, overriding the values from the stream. Bandwidth is given as a fraction, i.e. \fB--force-bandwidth=0.0013\fR means 0.13 percent (approximate FWHM). Radius is given in nm^-1. Wavelength is given in Angstroms. +.PD 0 +.IP \fB--harvest-file=\fIfn\fR +.PD +Write a list of parameters to \fIfn\fR, in JSON format. This is intended to be used for harvesting data into a database system. + .SH PARTIALITY MODELS The available partiality models are: -- cgit v1.2.3