mirror of
https://github.com/QuantumPackage/qp2.git
synced 2024-12-28 22:25:39 +01:00
415 lines
20 KiB
HTML
415 lines
20 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>qpsh — Quantum Package 2.0 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="qp_convert_output_to_ezfio" href="qp_convert_output_to_ezfio.html" />
|
|
<link rel="prev" title="configure" href="configure.html" />
|
|
|
|
|
|
<script src="../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../index.html" class="icon icon-home"> Quantum Package
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
2.0
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="caption"><span class="caption-text">Introduction</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../intro/install.html">Installation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../intro/selected_ci.html">Selected Configuration Interaction</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">User's guide</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick-start guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Interfaces</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="excited_states.html">Excited states</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="natural_orbitals.html">Natural orbitals</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="printing.html">Printing the near-<abbr title="Full Configuration Interaction">FCI</abbr> wave function</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Working with external plugins</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="qp_plugins.html">qp_plugins</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Index of commands</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="configure.html">configure</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">qpsh</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#qp">qp</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#ezfio-access">EZFIO access</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#running-programs">Running programs</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#getting-help">Getting help</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#running-quantum-package-commands">Running quantum package commands</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_convert_output_to_ezfio.html">qp_convert_output_to_ezfio</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_create_ezfio_from_xyz.html">qp_create_ezfio</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_edit.html">qp_edit</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_export_as_tgz.html">qp_export_as_tgz</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_plugins.html">qp_plugins</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_run.html">qp_run</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_set_frozen_core.html">qp_set_frozen_core</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_set_mo_class.html">qp_set_mo_class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_stop.html">qp_stop</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="qp_update.html">qp_update</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index.html#index-of-programs">Index of programs</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Programmer's guide</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/programming.html">Programming in the <em>Quantum Package</em></a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/ezfio.html">EZFIO</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/plugins.html">Developing plugins</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/index.html">Index for programmers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/plugins.html">Developing plugins</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Appendix</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../appendix/benchmarks.html">Benchmarks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../appendix/research.html">Some research made with the <em>Quantum Package</em></a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../appendix/license.html">License</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../appendix/contributors.html">Contributors</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">Quantum Package</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="index.html">Index of commands</a> »</li>
|
|
|
|
<li>qpsh</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="../_sources/users_guide/qpsh.rst.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="qpsh">
|
|
<span id="id1"></span><h1>qpsh<a class="headerlink" href="#qpsh" title="Permalink to this headline">¶</a></h1>
|
|
<p><strong class="command">qpsh</strong> is the <em>Quantum Package</em> shell. It is a Bash shell with all the
|
|
required evironment variables loaded, a modified prompt, and the
|
|
<a class="reference internal" href="#qp"><span class="std std-ref">qp</span></a> command.</p>
|
|
<div class="section" id="qp">
|
|
<span id="id2"></span><h2>qp<a class="headerlink" href="#qp" title="Permalink to this headline">¶</a></h2>
|
|
<p>This command is a hub to the most used command within <em>Quantum Package</em>. The power
|
|
of the <a class="reference internal" href="#qpsh"><span class="std std-ref">qpsh</span></a> shell is the auto-completion that comes when the
|
|
<kbd class="kbd docutils literal notranslate"><Tab></kbd> key is pressed with the <a class="reference internal" href="#qp"><span class="std std-ref">qp</span></a> command.</p>
|
|
<div class="section" id="ezfio-access">
|
|
<h3>EZFIO access<a class="headerlink" href="#ezfio-access" title="Permalink to this headline">¶</a></h3>
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-set-file">
|
|
<code class="descname">set_file</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-set-file" title="Permalink to this definition">¶</a></dt>
|
|
<dd><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="n">set_file</span> <span class="n">EZFIO_DIR</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Sets the current <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory. All the following instruction will be
|
|
relative to this directory.</p>
|
|
<p>This command is equivalent to <strong class="command">ezfio set_file EZFIO_DIR</strong>.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-unset-file">
|
|
<code class="descname">unset_file</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-unset-file" title="Permalink to this definition">¶</a></dt>
|
|
<dd><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="n">unset_file</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Unsets the current <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory.</p>
|
|
<p>This command is equivalent to <strong class="command">ezfio unset_file</strong>.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-has">
|
|
<code class="descname">has</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-has" title="Permalink to this definition">¶</a></dt>
|
|
<dd><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="n">has</span> <span class="o"><</span><span class="n">module</span><span class="o">></span> <span class="o"><</span><span class="n">parameter</span><span class="o">></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>If the <cite><module>/<parameter></cite> is set in the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory, returns 1.
|
|
Otherwise returns 0.</p>
|
|
<p>This command is equivalent to <strong class="command">ezfio has <module> <parameter></strong>.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-get">
|
|
<code class="descname">get</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-get" title="Permalink to this definition">¶</a></dt>
|
|
<dd><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="n">get</span> <span class="o"><</span><span class="n">module</span><span class="o">></span> <span class="o"><</span><span class="n">parameter</span><span class="o">></span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Returns the value of <cite><module>/<parameter></cite>.</p>
|
|
<p>This command is equivalent to <strong class="command">ezfio get <module> <parameter></strong>.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-set">
|
|
<code class="descname">set</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-set" title="Permalink to this definition">¶</a></dt>
|
|
<dd><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="nb">set</span> <span class="o"><</span><span class="n">module</span><span class="o">></span> <span class="o"><</span><span class="n">parameter</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">]</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Sets the value of <cite><module>/<parameter></cite>. If the value is not given in
|
|
the command line it is read from the standard input.</p>
|
|
<p>This command is equivalent to
|
|
<strong class="command">ezfio set <module> <parameter> [<value>]</strong>.</p>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="running-programs">
|
|
<h3>Running programs<a class="headerlink" href="#running-programs" title="Permalink to this headline">¶</a></h3>
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-run">
|
|
<code class="descname">run</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-run" title="Permalink to this definition">¶</a></dt>
|
|
<dd><blockquote>
|
|
<div><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="p">(</span><span class="n">run</span><span class="o">|</span><span class="n">srun</span><span class="o">|</span><span class="n">mpirun</span><span class="p">)</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o"><</span><span class="n">program</span><span class="o">></span>
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
<p>Runs <a class="reference internal" href="qp_run.html#qp-run"><span class="std std-ref">qp_run</span></a>, <span class="xref std std-ref">qp_srun</span>, or <span class="xref std std-ref">qp_mpirun</span> using the current
|
|
<a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-stop">
|
|
<code class="descname">stop</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-stop" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp stop</strong> : runs <a class="reference internal" href="qp_stop.html#qp-stop"><span class="std std-ref">qp_stop</span></a></p>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="getting-help">
|
|
<h3>Getting help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h3>
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-man">
|
|
<code class="descname">man</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-man" title="Permalink to this definition">¶</a></dt>
|
|
<dd><blockquote>
|
|
<div><div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp</span> <span class="n">man</span> <span class="p">(</span><span class="o"><</span><span class="n">program</span><span class="o">>|<</span><span class="n">qp_command</span><span class="o">></span><span class="p">)</span>
|
|
</pre></div>
|
|
</div>
|
|
</div></blockquote>
|
|
<p>Displays a man page for a <em>Quantum Package</em> program or a <em>Quantum Package</em> command.</p>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="running-quantum-package-commands">
|
|
<h3>Running quantum package commands<a class="headerlink" href="#running-quantum-package-commands" title="Permalink to this headline">¶</a></h3>
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">qp_</span></code> commands can be run without specifying the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory:</p>
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-convert-output-to-ezfio">
|
|
<code class="descname">convert_output_to_ezfio</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-convert-output-to-ezfio" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp convert_output_to_ezfio</strong> : runs <a class="reference internal" href="qp_convert_output_to_ezfio.html#qp-convert-output-to-ezfio"><span class="std std-ref">qp_convert_output_to_ezfio</span></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-create-ezfio">
|
|
<code class="descname">create_ezfio</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-create-ezfio" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp create_ezfio</strong> : runs <a class="reference internal" href="qp_create_ezfio_from_xyz.html#qp-create-ezfio"><span class="std std-ref">qp_create_ezfio</span></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-plugins">
|
|
<code class="descname">plugins</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-plugins" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp plugins</strong> : runs <a class="reference internal" href="qp_plugins.html#qp-plugins"><span class="std std-ref">qp_plugins</span></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-reset">
|
|
<code class="descname">reset</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-reset" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp reset</strong> : runs <span class="xref std std-ref">qp_reset</span></p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-set-frozen-core">
|
|
<code class="descname">set_frozen_core</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-set-frozen-core" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp set_frozen_core</strong> : runs <a class="reference internal" href="qp_set_frozen_core.html#qp-set-frozen-core"><span class="std std-ref">qp_set_frozen_core</span></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-set-mo-class">
|
|
<code class="descname">set_mo_class</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-set-mo-class" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp set_mo_class</strong> : runs <a class="reference internal" href="qp_set_mo_class.html#qp-set-mo-class"><span class="std std-ref">qp_set_mo_class</span></a></p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-arg-update">
|
|
<code class="descname">update</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-arg-update" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><strong class="command">qp update</strong> : runs <a class="reference internal" href="qp_update.html#qp-update"><span class="std std-ref">qp_update</span></a></p>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="qp_convert_output_to_ezfio.html" class="btn btn-neutral float-right" title="qp_convert_output_to_ezfio" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="configure.html" class="btn btn-neutral" title="configure" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2018, A. Scemama, E. Giner
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |