Skip to content

Commit

Permalink
Expanding on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ifilot committed Sep 7, 2023
1 parent 61d3bab commit 3d03a82
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/execution_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ acceleration to speed up the execution. This is especially beneficial when
performing a similarity analysis. :program:`Bramble` supports multi-GPU
setups, so one can use multiple GPUs if more than one GPU is available.

.. warning::
:program:`Bramble` requires a GPU with at least 8Gb of memory. :program:`Bramble`
will check whether the GPU supports the calculation prior to execution and throws
an error when the GPU is not supported. You can also check the memory available
on your GPU by running ``bramblecuda``.

When performing the similarity analysis, an inventory of all the jobs is made.
``N+1`` OpenMP threads are being spawned where ``N`` equals the number of GPUs.
Each GPU gets assigned a CPU thread and jobs are relayed to the GPU via the CPU
Expand Down
3 changes: 2 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ On Debian-based operating systems, one can run the following::
The compilation instructions below can be readily used.

.. warning::
In order to compile for GPU using CUDA, one needs Eigen3 version **3.4.0** or higher.
* In order to compile for GPU using CUDA, one needs Eigen3 version **3.4.0** or higher.
* Your GPU needs at least 8Gb of memory in order to use Bramble.

Compilation
-----------
Expand Down

0 comments on commit 3d03a82

Please sign in to comment.