mirror of
https://github.com/QuantumPackage/qp2.git
synced 2024-07-22 18:57:36 +02:00
328 lines
14 KiB
HTML
328 lines
14 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>qp_edit — 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_export_as_tgz" href="qp_export_as_tgz.html" />
|
|
<link rel="prev" title="qp_create_ezfio" href="qp_create_ezfio_from_xyz.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"><a class="reference internal" href="qpsh.html">qpsh</a></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 current"><a class="current reference internal" href="#">qp_edit</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li>
|
|
</ul>
|
|
</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>qp_edit</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="../_sources/users_guide/qp_edit.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="qp-edit">
|
|
<span id="id1"></span><h1>qp_edit<a class="headerlink" href="#qp-edit" title="Permalink to this headline">¶</a></h1>
|
|
<p>This command reads the content of the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory and creates
|
|
a temporary file containing the data. The data is presented as a
|
|
<em>ReStructured Text</em> (rst) document, where each section corresponds to
|
|
the corresponding <em>Quantum Package</em> module. The content of the file can be modified
|
|
to change the input parameters. When the text editor is closed, the
|
|
updated data is saved into the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">The text editor which will be opened is defined by the <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">EDITOR</span></code>
|
|
environment variable. If this variable is not set, the <strong class="command">vi</strong>
|
|
text editor will be used by default.</p>
|
|
</div>
|
|
<div class="admonition warning">
|
|
<p class="first admonition-title">Warning</p>
|
|
<p class="last">When the wave function is too large (more than 10 000 determinants), the
|
|
determinants are not displayed.</p>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p>On some machines the terminal will be stuck in inverted colors after using
|
|
qp_edit. To Avoid this problem, put in your <code class="file docutils literal notranslate"><span class="pre">$HOME/.vimrc</span></code>:</p>
|
|
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">t_ti</span><span class="o">=</span>
|
|
<span class="nb">set</span> <span class="n">t_te</span><span class="o">=</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="usage">
|
|
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
|
|
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp_edit</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">n</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="o"><</span><span class="nb">range</span><span class="o">></span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="p">]</span> <span class="n">EZFIO_DIR</span>
|
|
</pre></div>
|
|
</div>
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-edit-c">
|
|
<code class="descname">-c</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--check</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-edit-c" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Checks the input data</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-edit-h">
|
|
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-qp-edit-h" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Print the help text and exits</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-edit-n">
|
|
<code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--ndet</code><code class="descclassname">=<int></code><a class="headerlink" href="#cmdoption-qp-edit-n" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Truncates the wavefunction to the target number of determinants</p>
|
|
</dd></dl>
|
|
|
|
<dl class="option">
|
|
<dt id="cmdoption-qp-edit-s">
|
|
<code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--state</code><code class="descclassname">=<range></code><a class="headerlink" href="#cmdoption-qp-edit-s" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Select the states to extract from the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory, using the same conventions
|
|
as <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>. See example below.</p>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="example">
|
|
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
|
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qp_edit</span> <span class="o">--</span><span class="n">state</span><span class="o">=</span><span class="s2">"[1,3-5]"</span> <span class="n">test</span><span class="o">.</span><span class="n">ezfio</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Removes all states except states 1,3,4 and 5 from <code class="file docutils literal notranslate"><span class="pre">test.ezfio</span></code>.
|
|
The resulting <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> directory has 4 states.</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="qp_export_as_tgz.html" class="btn btn-neutral float-right" title="qp_export_as_tgz" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="qp_create_ezfio_from_xyz.html" class="btn btn-neutral" title="qp_create_ezfio" 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> |