mirror of
https://github.com/QuantumPackage/qp2.git
synced 2024-12-22 12:23:43 +01:00
105 lines
2.4 KiB
Groff
105 lines
2.4 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "QP_RUN" "1" "Jun 15, 2019" "2.0" "Quantum Package"
|
|
.SH NAME
|
|
qp_run \- | Quantum Package >
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.sp
|
|
Command used to run a calculation.
|
|
.sp
|
|
If the \fBUSR1\fP signal is sent to \fI\%qp_run\fP, the application will
|
|
call qp_stop to request a clean termination. In a SLURM script,
|
|
you can ask SLURM to send the \fBUSR1\fP signal 120 seconds before end of
|
|
the time limit with
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
#SBATCH \-\-signal=B:USR1@120
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
There is a directory named \fBwork\fP in the \fI\%EZFIO\fP\&. This directory
|
|
will contain work files which can be large, so it is recommended to
|
|
work in the scratch directory. To archive the \fI\%EZFIO\fP directory, it is
|
|
recommended to remove the \fBwork\fP directory.
|
|
.SH USAGE
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
qp_run [\-h] [\-p <string>] [\-s] [\-\-] PROGRAM EZFIO_DIR
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fBPROGRAM\fP is the name of the \fIQuantum Package\fP program to be run, and \fBEZFIO_DIR\fP
|
|
is the name of the \fI\%EZFIO\fP directory containing the data.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Displays the list of available \fIQuantum Package\fP programs.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-p <string>, \-\-prefix=<string>
|
|
Prefix before running the program. This option is used to run
|
|
programs like like gdb or valgrind.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-s, \-\-slave
|
|
This option needs to be set to run a slave job for \fBPROGRAM\fP, to
|
|
accelerate another running instance of the \fIQuantum Package\fP\&.
|
|
.UNINDENT
|
|
.SH EXAMPLE
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
qp_run fci h2o.ezfio &
|
|
srun qp_run \-\-slave fci h2o.ezfio
|
|
wait
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH AUTHOR
|
|
A. Scemama, E. Giner
|
|
.SH COPYRIGHT
|
|
2019, A. Scemama, E. Giner
|
|
.\" Generated by docutils manpage writer.
|
|
.
|