Update documentation for v0.21.0 (#1229)

Author: havogt

Diff for: docs/_sources/getting_started/getting_started.rst.txt

@@ -338,6 +338,10 @@ we won't discuss them now in detail. In brief:
 - In order to use the :math:`(i,j,k)` syntax we need to define the symbols to point to the respective dimensions.
 - A common pattern is to use the preprocessor flag ``__CUDACC__`` to distinguish between CPU and GPU code. We use this to set the :term:`Backend`.
 
+The code example can be compiled using the following simple CMake script (requires an installation of GridTools, see :ref:`installation`).
+
+.. literalinclude:: code/CMakeLists.txt
+
 -------------------------------------
 Assembling Stencils: Smoothing Filter
 -------------------------------------

Diff for: docs/_sources/introduction/introduction.rst.txt

@@ -2,13 +2,13 @@
 
 .. _introduction:
 
-=====================
+============
 Introduction
-=====================
+============
 
------------------------------
+-----------------
 What Is GridTools
------------------------------
+-----------------
 
 The |GT| (GT) framework is a set of libraries and utilities to develop performance portable applications in which
 stencil operations on grids are central. The focus of the project is on regular and block-structured grids as are
@@ -46,9 +46,9 @@ abstract descriptions of a stencils, the DSL allows |GT| can apply architecture-
 computations in order to be optimal on the target hardware.
 
 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^
 Dependencies
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^
 
 |GT| requires at least a header-only installation of Boost_. Besides some boost utilities, it depends on ``boost::mpl`` and ``boost::fusion``.
 
@@ -57,11 +57,18 @@ Additionally, |GT| requires a recent version of CMake_.
 .. _Boost: https://www.boost.org/
 .. _CMake: https://www.cmake.org/
 
-|GT| requires a modern compiler. A list of supported compilers can be found on `github <https://github.com/eth-cscs/gridtools/wiki/Supported-Compilers>`_.
+|GT| requires a modern compiler. A list of supported compilers can be found on `github <https://github.com/GridTools/gridtools>`_.
 
-^^^^^^^^^^^^^^^^^^^^
+
+.. _installation:
+
+--------------------
+Installation and Use
+--------------------
+
+^^^^^^^^^^^^^
 Simple Script
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^
 
 We first provide a sample of the commands needed to enable the multicore and CUDA backends, install them in ``/usr/local``,
 and run the gridtools tests.
@@ -75,10 +82,6 @@ and run the gridtools tests.
  make install -j4
  make test
 
------------------------------
-Installation and Use
------------------------------
-
 |GT| uses CMake as building system. The installation can be configured using `ccmake`. The following variables control the back-ends that will be supported by the runtime components of the installation, namely :ref:`GCL <halo-exchanges>`.
 
 .. code-block:: shell
@@ -130,9 +133,9 @@ the following set of instructions:
   make -j4
 
 
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^
 Using GridTools
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^
 
 Using |GT| follows standard CMake practices. To indicate where the |GT| can be found,
 CMake should be provided with the variable ``GridTools_DIR``,
@@ -156,8 +159,8 @@ Targets that need |GT| should link against ``GridTools::gridtools``. If the comm
  add_library(my_library source.cpp)
  target_link_libraries(my_library PUBLIC GridTools::gridtools)
 
------------------------------
+------------
 Contributing
------------------------------
+------------
 
 Contributions to the |GT| set of libraries are welcome. However, our policy is that we will be the official maintainers and providers of the GridTools code. We believe that this will provide our users with a clear reference point for support and guarantees on timely interactions. For this reason, we require that external contributions to |GT| will be accepted after their authors provide to us a signed copy of a copyright release form to ETH Zurich.

Diff for: docs/getting_started/getting_started.html

@@ -676,6 +676,17 @@ <h3>Full GridTools Laplacian<a class="headerlink" href="#full-gridtools-laplacia
 <li>In order to use the <span class="math">\((i,j,k)\)</span> syntax we need to define the symbols to point to the respective dimensions.</li>
 <li>A common pattern is to use the preprocessor flag <code class="docutils literal"><span class="pre">__CUDACC__</span></code> to distinguish between CPU and GPU code. We use this to set the <a class="reference internal" href="../glossary/glossary.html#term-backend"><span class="xref std std-term">Backend</span></a>.</li>
 </ul>
+<p>The code example can be compiled using the following simple CMake script (requires an installation of GridTools, see <a class="reference internal" href="../introduction/introduction.html#installation"><span class="std std-ref">Installation and Use</span></a>).</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cmake_minimum_required</span><span class="p">(</span><span class="n">VERSION</span> <span class="mf">3.12</span><span class="o">.</span><span class="mi">4</span><span class="p">)</span>
+
+<span class="n">project</span><span class="p">(</span><span class="n">GridTools</span><span class="o">-</span><span class="n">laplacian</span> <span class="n">LANGUAGES</span> <span class="n">CXX</span><span class="p">)</span>
+
+<span class="n">find_package</span><span class="p">(</span><span class="n">GridTools</span> <span class="mf">0.21</span><span class="o">.</span><span class="mi">0</span> <span class="n">REQUIRED</span><span class="p">)</span>
+
+<span class="n">add_executable</span><span class="p">(</span><span class="n">gt_laplacian</span> <span class="n">test_gt_laplacian</span><span class="o">.</span><span class="n">cpp</span><span class="p">)</span>
+<span class="n">target_link_libraries</span><span class="p">(</span><span class="n">gt_laplacian</span> <span class="n">GridTools</span><span class="p">::</span><span class="n">gridtools</span><span class="p">)</span>
+</pre></div>
+</div>
 </div>
 </div>
 <div class="section" id="assembling-stencils-smoothing-filter">

Diff for: docs/introduction/introduction.html

@@ -99,10 +99,10 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#what-is-gridtools">What Is GridTools</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#dependencies">Dependencies</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#simple-script">Simple Script</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#installation-and-use">Installation and Use</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#simple-script">Simple Script</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#using-gridtools">Using GridTools</a></li>
 </ul>
 </li>
@@ -216,8 +216,11 @@ <h2>What Is GridTools<a class="headerlink" href="#what-is-gridtools" title="Perm
 <h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
 <p><cite>GridTools</cite> requires at least a header-only installation of <a class="reference external" href="https://www.boost.org/">Boost</a>. Besides some boost utilities, it depends on <code class="docutils literal"><span class="pre">boost::mpl</span></code> and <code class="docutils literal"><span class="pre">boost::fusion</span></code>.</p>
 <p>Additionally, <cite>GridTools</cite> requires a recent version of <a class="reference external" href="https://www.cmake.org/">CMake</a>.</p>
-<p><cite>GridTools</cite> requires a modern compiler. A list of supported compilers can be found on <a class="reference external" href="https://github.com/eth-cscs/gridtools/wiki/Supported-Compilers">github</a>.</p>
+<p><cite>GridTools</cite> requires a modern compiler. A list of supported compilers can be found on <a class="reference external" href="https://github.com/GridTools/gridtools">github</a>.</p>
 </div>
+</div>
+<div class="section" id="installation-and-use">
+<span id="installation"></span><h2>Installation and Use<a class="headerlink" href="#installation-and-use" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="simple-script">
 <h3>Simple Script<a class="headerlink" href="#simple-script" title="Permalink to this headline">¶</a></h3>
 <p>We first provide a sample of the commands needed to enable the multicore and CUDA backends, install them in <code class="docutils literal"><span class="pre">/usr/local</span></code>,
@@ -230,10 +233,6 @@ <h3>Simple Script<a class="headerlink" href="#simple-script" title="Permalink to
 make <span class="nb">test</span>
 </pre></div>
 </div>
-</div>
-</div>
-<div class="section" id="installation-and-use">
-<h2>Installation and Use<a class="headerlink" href="#installation-and-use" title="Permalink to this headline">¶</a></h2>
 <p><cite>GridTools</cite> uses CMake as building system. The installation can be configured using <cite>ccmake</cite>. The following variables control the back-ends that will be supported by the runtime components of the installation, namely <a class="reference internal" href="../user_manual/user_manual.html#halo-exchanges"><span class="std std-ref">GCL</span></a>.</p>
 <div class="highlight-shell"><div class="highlight"><pre><span></span>GT_ENABLE_TARGET_CUDA <span class="c1"># For CUDA GPUs</span>
 GT_ENABLE_TARGET_X86  <span class="c1"># For cache based multicores and naive implementation</span>
@@ -271,6 +270,7 @@ <h2>Installation and Use<a class="headerlink" href="#installation-and-use" title
 make -j4
 </pre></div>
 </div>
+</div>
 <div class="section" id="using-gridtools">
 <h3>Using GridTools<a class="headerlink" href="#using-gridtools" title="Permalink to this headline">¶</a></h3>
 <p>Using <cite>GridTools</cite> follows standard CMake practices. To indicate where the <cite>GridTools</cite> can be found,