mirror of
https://github.com/QuantumPackage/qp2.git
synced 2024-11-03 20:53:54 +01:00
186 lines
4.3 KiB
Groff
186 lines
4.3 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "QP_PLUGINS" "1" "Jun 15, 2019" "2.0" "Quantum Package"
|
|
.SH NAME
|
|
qp_plugins \- | 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
|
|
This command deals with all external plugins of \fIQuantum Package\fP\&. Plugin
|
|
repositories can be downloaded, and the plugins in these repositories
|
|
can be installed/uninstalled or created.
|
|
.SH USAGE
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
qp_plugins list [\-i] [\-u] [\-q]
|
|
qp_plugins download <url>
|
|
qp_plugins install <name>...
|
|
qp_plugins uninstall <name>
|
|
qp_plugins create \-n <name> [\-r <repo>] [<needed_modules>...]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B list
|
|
List all the available plugins.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-i, \-\-installed
|
|
List all the \fIinstalled\fP plugins.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-u, \-\-uninstalled
|
|
List all the \fIuninstalled\fP plugins.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-q, \-\-repositories
|
|
List all the downloaded repositories.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B download <url>
|
|
Download an external repository. The URL points to a tar.gz file or a
|
|
git repository, for example:
|
|
.INDENT 7.0
|
|
.IP \(bu 2
|
|
\fI\%http://example.com/site/example.tar.gz\fP
|
|
.IP \(bu 2
|
|
\fI\%git@gitlab.com\fP:user/example_repository
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B install <plugin_name>
|
|
Install the plugin \fBplugin_name\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B uninstall <plugin_name>
|
|
Uninstall the plugin \fBplugin_name\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B update
|
|
Update the repositories of the plugins. Should be followed by a re\-compilation.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-n, \-\-name=<plugin_name>
|
|
Create a new plugin named \fBplugin_name\fP (in local repository by default).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-r, \-\-repository=<repo>
|
|
Specify in which repository the new plugin will be created.
|
|
.UNINDENT
|
|
.SH EXAMPLE
|
|
.sp
|
|
Let us download, install and compile some specific external plugins from
|
|
\fI\%https://gitlab.com/eginer/qp_plugins_eginer\fP .
|
|
.sp
|
|
First, download the git repo associated to these plugins. To do so,
|
|
first go to the \fIplugins\fP directory in the \fIQuantum Package\fP and execute:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
qp_plugins download https://gitlab.com/eginer/qp_plugins_eginer
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
This will create in the directory \fIplugins\fP a local copy of
|
|
the git repo located at the URL you indicated. Then, go in
|
|
\fIqp_plugins_eginer/stable/\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
cd qp_plugins_eginer/stable/
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
In the directory \fIstable\fP, there are many directories which all
|
|
correspond to a specific plugin that have been developed by the person
|
|
in charge of the repository. All these plugins might use some global
|
|
variables and routines contained in the core modules of the \fIQuantum Package\fP\&.
|
|
.sp
|
|
Now let us install the plugin \fIrsdft_cipsi\fP:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
qp_plugins install rsdft_cipsi
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
This will link this directory to the \fIQuantum Package\fP which means that when the code
|
|
will be compiled, this plugin will be compiled to and therefore all the
|
|
executables/scripts/input keywords contained in this module will be
|
|
available as if there were part of the core of the \fIQuantum Package\fP\&.
|
|
.sp
|
|
Then, to compile the new plugin, just recompile the \fIQuantum Package\fP as usual by
|
|
going at the root of the \fIQuantum Package\fP directory:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
cd $QP_ROOT
|
|
ninja
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Finally, if you go back to the plugin directory you just installed, you
|
|
should see all the executables/scripts which have been created and which
|
|
are now available with the \fIqp_run\fP command.
|
|
.SH AUTHOR
|
|
A. Scemama, E. Giner
|
|
.SH COPYRIGHT
|
|
2019, A. Scemama, E. Giner
|
|
.\" Generated by docutils manpage writer.
|
|
.
|