deploy

Author: ghchengit

_sources/commands.rst.txt

@@ -37,17 +37,17 @@ CRANE本质上是一个命令行程序，它通过各种命令行来执行计算
     :prog: crane compare
     :nested: full
 
-.. _crane_visualize:
+.. .. _crane_visualize:
 
-.. click:: ngm.cli:visualize
-    :prog: crane visualize
-    :nested: full
+.. .. click:: ngm.cli:visualize
+..     :prog: crane visualize
+..     :nested: full
 
-.. _crane_to_openmc:
+.. .. _crane_to_openmc:
 
-.. click:: ngm.cli:to_openmc
-    :prog: crane to-openmc
-    :nested: full
+.. .. click:: ngm.cli:to_openmc
+..     :prog: crane to-openmc
+..     :nested: full
 
 
 .. _interactive_commands:

_sources/usersguide/openmc.rst.txt

@@ -42,7 +42,7 @@ OpenMC 接口
 
 就能够基于CRANE模型自动生成OpenMC的计算输入，并直接驱动OpenMC计算。详细命令行功能见 :ref:`crane_to_openmc`。
 
-.. note:: 执行 :ref:`crane_to_openmc` 命令后，CRANE会创建一个名为 **:ref:`core_name` + __openmc** 的文件夹，
+.. note:: 执行 :ref:`crane_to_openmc` 命令后，CRANE会创建一个名为 :ref:`core_name` + ``__openmc`` 的文件夹，
           OpenMC所有的输入文件都在该文件夹内。
 
 利用 `openmc plotter <https://github.com/openmc-dev/plotter>`_ 工具对上述命令产生OpenMC模型进行可视化：

commands.html

@@ -59,7 +59,6 @@
 <li class="toctree-l3"><a class="reference internal" href="#crane-run">crane run</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#crane-check-region-overlap">crane check-region-overlap</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#crane-compare">crane compare</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#crane-visualize">crane visualize</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#interactive-commands">交互式可视化命令行</a><ul>
@@ -120,8 +119,8 @@
 <p>CRANE本质上是一个命令行程序，它通过各种命令行来执行计算、绘制可视化图表等，CRANE的命令行可以分为以下两类:</p>
 <ol class="arabic simple">
 <li><p>基本命令行，该类命令行形式为 <code class="docutils literal notranslate"><span class="pre">crane</span> <span class="pre">COMMAND</span> <span class="pre">[ARGS]</span></code>，是CRANE最基本的命令行，如 <a class="reference internal" href="#crane-run"><span class="std std-ref">crane run</span></a>、
-<a class="reference internal" href="#crane-visualize"><span class="std std-ref">crane visualize</span></a>、<a class="reference internal" href="#crane-compare"><span class="std std-ref">crane compare</span></a> 等；</p></li>
-<li><p>交互式命令行，该类命令行必须通过 <a class="reference internal" href="#crane-visualize"><span class="std std-ref">crane visualize</span></a> 进入交互式命令行界面后执行，为模型及结果可视化相关的命令行工具，
+<span class="xref std std-ref">crane_visualize</span>、<a class="reference internal" href="#crane-compare"><span class="std std-ref">crane compare</span></a> 等；</p></li>
+<li><p>交互式命令行，该类命令行必须通过 <span class="xref std std-ref">crane_visualize</span> 进入交互式命令行界面后执行，为模型及结果可视化相关的命令行工具，
 如 <a class="reference internal" href="usersguide/visualization.html#plot-model"><span class="std std-ref">模型可视化</span></a>、<a class="reference internal" href="usersguide/visualization.html#plot-power-distribution"><span class="std std-ref">功率分布可视化</span></a> 等。</p></li>
 </ol>
 <section id="base-commands">
@@ -374,33 +373,10 @@
 <dd><p>Optional argument(s)</p>
 </dd></dl>
 
-</section>
-<section id="crane-visualize">
-<span id="crane-visualize"></span><h3>crane visualize<a class="headerlink" href="#crane-visualize" title="Link to this heading">¶</a></h3>
-<p>Start a interactive command line mode, which contains rich
-visualization functions.</p>
-<p>FILENAME is the name of file with path in which the model defined, both yaml
-and json format are acceptable. Or the name of output file in HDF5 format with path.</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>crane<span class="w"> </span>visualize<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>FILENAME<span class="w"> </span><span class="o">[</span>REFERENCE_FILE<span class="o">]</span>...
-</pre></div>
-</div>
-<p class="rubric">Arguments</p>
-<dl class="std option">
-<dt class="sig sig-object std" id="cmdoption-crane-visualize-arg-FILENAME">
-<span class="sig-name descname"><span class="pre">FILENAME</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-crane-visualize-arg-FILENAME" title="Link to this definition">¶</a></dt>
-<dd><p>Required argument</p>
-</dd></dl>
-
-<dl class="std option">
-<dt class="sig sig-object std" id="cmdoption-crane-visualize-arg-REFERENCE_FILE">
-<span class="sig-name descname"><span class="pre">REFERENCE_FILE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-crane-visualize-arg-REFERENCE_FILE" title="Link to this definition">¶</a></dt>
-<dd><p>Optional argument(s)</p>
-</dd></dl>
-
 </section>
 </section>
 <section id="interactive-commands">
-<span id="crane-to-openmc"></span><span id="id3"></span><h2>交互式可视化命令行<a class="headerlink" href="#interactive-commands" title="Link to this heading">¶</a></h2>
+<span id="id3"></span><h2>交互式可视化命令行<a class="headerlink" href="#interactive-commands" title="Link to this heading">¶</a></h2>
 <section id="plot-model">
 <span id="cli-plot-model"></span><h3>plot-model<a class="headerlink" href="#plot-model" title="Link to this heading">¶</a></h3>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>plot-model<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>

genindex.html

@@ -1175,15 +1175,6 @@ <h2 id="C">C</h2>
         <li><a href="commands.html#cmdoption-crane-run-visualize">-V</a>
 </li>
         <li><a href="commands.html#cmdoption-crane-run-arg-INPUT_FILE">INPUT_FILE</a>
-</li>
-      </ul></li>
-      <li>
-    crane-visualize command line option
-
-      <ul>
-        <li><a href="commands.html#cmdoption-crane-visualize-arg-FILENAME">FILENAME</a>
-</li>
-        <li><a href="commands.html#cmdoption-crane-visualize-arg-REFERENCE_FILE">REFERENCE_FILE</a>
 </li>
       </ul></li>
   </ul></td>
@@ -1199,8 +1190,6 @@ <h2 id="F">F</h2>
         <li><a href="commands.html#cmdoption-crane-check-region-overlap-arg-FILENAME">crane-check-region-overlap command line option</a>
 </li>
         <li><a href="commands.html#cmdoption-crane-compare-arg-FILENAME">crane-compare command line option</a>
-</li>
-        <li><a href="commands.html#cmdoption-crane-visualize-arg-FILENAME">crane-visualize command line option</a>
 </li>
       </ul></li>
   </ul></td>
@@ -1716,8 +1705,6 @@ <h2 id="R">R</h2>
 
       <ul>
         <li><a href="commands.html#cmdoption-crane-compare-arg-REFERENCE_FILE">crane-compare command line option</a>
-</li>
-        <li><a href="commands.html#cmdoption-crane-visualize-arg-REFERENCE_FILE">crane-visualize command line option</a>
 </li>
       </ul></li>
   </ul></td>

objects.inv

@@ -413,7 +413,7 @@ <h3>计算控制参数设置<a class="headerlink" href="#id5" title="Link to thi
 <section id="crane">
 <h2>运行CRANE<a class="headerlink" href="#crane" title="Link to this heading">¶</a></h2>
 <p>输入文件填写完成以后，首先可以用 <a class="reference internal" href="../usersguide/visualization.html#usersguide-visualization"><span class="std std-ref">可视化</span></a> 功能来检查下模型的几何、材料布置是否正确。执行
-<a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 命令进入CRANE的可视化交互式命令行环境:</p>
+<span class="xref std std-ref">crane_visualize</span> 命令进入CRANE的可视化交互式命令行环境:</p>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>crane<span class="w"> </span>visualize<span class="w"> </span>VERA_2A.yaml
 </pre></div>
 </div>
@@ -460,10 +460,10 @@ <h2>查看、比较及可视化结果数据<a class="headerlink" href="#id6" tit
 <p>另外，CRANE还会产生一个同样命名的 Excel 文件，该文件保存了主要的一些结果数据，如计算状态参数、硼降曲线、
 组件功率分布、轴向功率分布、控制棒价值等，方便用户在windows系统上进行查看编辑。关于该文件的详细说明请参阅
 <a class="reference internal" href="../io_formats/output_excel.html#io-file-formats-output-excel"><span class="std std-ref">Excel 结果文件</span></a>。</p>
-<p>和执行 <a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 命令一样，计算完成后CRANE默认会进入可视化交互式命令行环境，执行命令:</p>
+<p>和执行 <span class="xref std std-ref">crane_visualize</span> 命令一样，计算完成后CRANE默认会进入可视化交互式命令行环境，执行命令:</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p><a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 命令后面也可以接计算结果文件，如 <code class="docutils literal notranslate"><span class="pre">crane</span> <span class="pre">visualize</span> <span class="pre">VERA_2A.h5</span></code>
+<p><span class="xref std std-ref">crane_visualize</span> 命令后面也可以接计算结果文件，如 <code class="docutils literal notranslate"><span class="pre">crane</span> <span class="pre">visualize</span> <span class="pre">VERA_2A.h5</span></code>
 即可进入可视化交互式命令行环境。</p>
 </div>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>plot-power-distribution<span class="w"> </span>--power-type<span class="w"> </span>pin-integral

quickstart/index.html

@@ -137,10 +137,10 @@ <h2><span class="section-number">13.1. </span>生成 OpenMC 输入并执行计
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>crane<span class="w"> </span>to-openmc<span class="w"> </span>VERA_5A_2D.yaml
 </pre></div>
 </div>
-<p>就能够基于CRANE模型自动生成OpenMC的计算输入，并直接驱动OpenMC计算。详细命令行功能见 <a class="reference internal" href="../commands.html#crane-to-openmc"><span class="std std-ref">交互式可视化命令行</span></a>。</p>
+<p>就能够基于CRANE模型自动生成OpenMC的计算输入，并直接驱动OpenMC计算。详细命令行功能见 <span class="xref std std-ref">crane_to_openmc</span>。</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>执行 <a class="reference internal" href="../commands.html#crane-to-openmc"><span class="std std-ref">交互式可视化命令行</span></a> 命令后，CRANE会创建一个名为 <strong>:ref:`core_name` + __openmc</strong> 的文件夹，
+<p>执行 <span class="xref std std-ref">crane_to_openmc</span> 命令后，CRANE会创建一个名为 <a class="reference internal" href="../io_formats/input.html#core-name"><span class="std std-ref">name</span></a> + <code class="docutils literal notranslate"><span class="pre">__openmc</span></code> 的文件夹，
 OpenMC所有的输入文件都在该文件夹内。</p>
 </div>
 <p>利用 <a class="reference external" href="https://github.com/openmc-dev/plotter">openmc plotter</a> 工具对上述命令产生OpenMC模型进行可视化：</p>
@@ -194,9 +194,9 @@ <h2><span class="section-number">13.1. </span>生成 OpenMC 输入并执行计
 </section>
 <section id="id3">
 <h2><span class="section-number">13.2. </span>对计算结果进行比较和可视化<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h2>
-<p>采用CRANE的 <a class="reference internal" href="../commands.html#crane-to-openmc"><span class="std std-ref">交互式可视化命令行</span></a> 功能进行OpenMC的模型产生和计算时，OpenMC会统计三维组件功率分布，
+<p>采用CRANE的 <span class="xref std std-ref">crane_to_openmc</span> 功能进行OpenMC的模型产生和计算时，OpenMC会统计三维组件功率分布，
 因此OpenMC计算完成后，除了比较特征值，还可以比较组件功率分布。</p>
-<p>类似于比较两个CRANE的结果，我们可以用 <a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 命令来比较CRANE的 <a class="reference internal" href="../io_formats/output_hdf5.html#io-file-formats-output-hdf5"><span class="std std-ref">HDF5 结果文件</span></a>
+<p>类似于比较两个CRANE的结果，我们可以用 <span class="xref std std-ref">crane_visualize</span> 命令来比较CRANE的 <a class="reference internal" href="../io_formats/output_hdf5.html#io-file-formats-output-hdf5"><span class="std std-ref">HDF5 结果文件</span></a>
 和OpenMC的 <a class="reference external" href="https://docs.openmc.org/en/stable/io_formats/statepoint.html">statepoint file</a>。</p>
 <p>如执行以下命令：</p>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>crane<span class="w"> </span>visualize<span class="w"> </span>VERA_5A_2D.h5<span class="w"> </span>VERA_5A_2D__openmc/statepoint2000.h5

searchindex.js

@@ -101,7 +101,7 @@
 
   <section id="usersguide-run">
 <span id="id1"></span><h1><span class="section-number">9. </span>启动计算<a class="headerlink" href="#usersguide-run" title="Link to this heading">¶</a></h1>
-<p>当输入文件准备好以后，首先可以通过命令行 <a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 对模型进行可视化，检查建模是否正确。有关可视化的详细介绍可参阅
+<p>当输入文件准备好以后，首先可以通过命令行 <span class="xref std std-ref">crane_visualize</span> 对模型进行可视化，检查建模是否正确。有关可视化的详细介绍可参阅
 <a class="reference internal" href="visualization.html#usersguide-visualization"><span class="std std-ref">可视化</span></a>。</p>
 <p>如果建模一切正常，就可以通过命令行 <a class="reference internal" href="../commands.html#crane-run"><span class="std std-ref">crane run</span></a> 来启动计算。</p>
 <p>以C5G7基准题为例，假设你准备好了基准问题 <a class="reference internal" href="../examples/c5g7.html#c5g7-3d"><span class="std std-ref">C5G7_3D</span></a> 输入文件，名为 <code class="docutils literal notranslate"><span class="pre">C5G7_3D.yaml</span></code>，

usersguide/openmc.html

@@ -190,10 +190,10 @@
 <p>CRANE内建的可视化功能都是基于两维矢量图的，如果你对堆芯三维可视化有需求，可关注CRANE的进展，
 我们正在研发基于web的堆芯三维可视化工具。</p>
 </div>
-<p>为了能够方便用户使用，所有可视化命令都采用交互式命令行方式，只要执行 <a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 命令进入到交互式命令行环境，
+<p>为了能够方便用户使用，所有可视化命令都采用交互式命令行方式，只要执行 <span class="xref std std-ref">crane_visualize</span> 命令进入到交互式命令行环境，
 按 <code class="docutils literal notranslate"><span class="pre">Tab</span></code> 键就可提示出可视化命令及选项。</p>
-<p>对于建模可视化，<a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 后面可以是 <a class="reference internal" href="../io_formats/input.html#io-file-formats-input"><span class="std std-ref">用户输入文件</span></a>，也可以是
-<a class="reference internal" href="../io_formats/output_hdf5.html#io-file-formats-output-hdf5"><span class="std std-ref">HDF5 结果文件</span></a>。但如果要进行计算结果可视化，<a class="reference internal" href="../commands.html#crane-visualize"><span class="std std-ref">crane visualize</span></a> 后面必须是
+<p>对于建模可视化，<span class="xref std std-ref">crane_visualize</span> 后面可以是 <a class="reference internal" href="../io_formats/input.html#io-file-formats-input"><span class="std std-ref">用户输入文件</span></a>，也可以是
+<a class="reference internal" href="../io_formats/output_hdf5.html#io-file-formats-output-hdf5"><span class="std std-ref">HDF5 结果文件</span></a>。但如果要进行计算结果可视化，<span class="xref std std-ref">crane_visualize</span> 后面必须是
 <a class="reference internal" href="../io_formats/output_hdf5.html#io-file-formats-output-hdf5"><span class="std std-ref">HDF5 结果文件</span></a>。</p>
 <p>比如，你可以执行以下命令</p>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>crane<span class="w"> </span>visualize<span class="w"> </span>VERA_7.yaml