Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RemiLehe committed May 20, 2024
1 parent d2b771f commit 111e7cf
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
13 changes: 10 additions & 3 deletions _sources/install/install_local.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,23 @@ Python. If Anaconda is not your default Python distribution, download and instal
A shortcut for this is: ``python3 -m pip install git+https://github.com/fbpic/fbpic.git``.

- **Optional:** In order to be able to run the code on a GPU,
install the additional package ``cupy``.
install the additional package ``cupy`` as well as dependencies needed to enable GPU support in ``numba``.

For CUDA versions below 12, install ``cupy`` and ``cuda-version`` (which will automatically install ``cudatoolkit``), for example
::


conda install -c conda-forge cupy
conda install -c conda-forge cupy cuda-version=11.8

For CUDA 12+ which no longer provides the ``cudatoolkit`` package, explicit installation of ``cuda-nvcc`` and ``cuda-nvrtc`` is required

::

conda install -c conda-forge cupy cuda-version=12.0 cuda-nvcc cuda-nvrtc

.. warning::

In the above command, you should choose a CUDA version that is **compatible
In the above commands, you should choose a CUDA version that is **compatible
with your GPU driver**. You can see the version of your GPU driver by typing
the command ``nvidia-smi``. You can then find the compatible CUDA
versions using `this table <https://docs.nvidia.com/deploy/cuda-compatibility/index.html#use-the-right-compat-package>`__.
Expand Down
11 changes: 8 additions & 3 deletions install/install_local.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,18 @@ <h2>Installing FBPIC<a class="headerlink" href="#installing-fbpic" title="Link t
</div>
</li>
<li><p><strong>Optional:</strong> In order to be able to run the code on a GPU,
install the additional package <code class="docutils literal notranslate"><span class="pre">cupy</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">cupy</span>
install the additional package <code class="docutils literal notranslate"><span class="pre">cupy</span></code> as well as dependencies needed to enable GPU support in <code class="docutils literal notranslate"><span class="pre">numba</span></code>.</p>
<p>For CUDA versions below 12, install <code class="docutils literal notranslate"><span class="pre">cupy</span></code> and <code class="docutils literal notranslate"><span class="pre">cuda-version</span></code> (which will automatically install <code class="docutils literal notranslate"><span class="pre">cudatoolkit</span></code>), for example</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">cupy</span> <span class="n">cuda</span><span class="o">-</span><span class="n">version</span><span class="o">=</span><span class="mf">11.8</span>
</pre></div>
</div>
<p>For CUDA 12+ which no longer provides the <code class="docutils literal notranslate"><span class="pre">cudatoolkit</span></code> package, explicit installation of <code class="docutils literal notranslate"><span class="pre">cuda-nvcc</span></code> and <code class="docutils literal notranslate"><span class="pre">cuda-nvrtc</span></code> is required</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">cupy</span> <span class="n">cuda</span><span class="o">-</span><span class="n">version</span><span class="o">=</span><span class="mf">12.0</span> <span class="n">cuda</span><span class="o">-</span><span class="n">nvcc</span> <span class="n">cuda</span><span class="o">-</span><span class="n">nvrtc</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>In the above command, you should choose a CUDA version that is <strong>compatible
<p>In the above commands, you should choose a CUDA version that is <strong>compatible
with your GPU driver</strong>. You can see the version of your GPU driver by typing
the command <code class="docutils literal notranslate"><span class="pre">nvidia-smi</span></code>. You can then find the compatible CUDA
versions using <a class="reference external" href="https://docs.nvidia.com/deploy/cuda-compatibility/index.html#use-the-right-compat-package">this table</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 111e7cf

Please sign in to comment.