Skip to content

Commit

Permalink
Updating links and descriptions in the Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JOOpdenhoevel authored Dec 1, 2022
1 parent 7769932 commit 9a9c8cd
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ To be done.

### Required Software

This library requires the "Intel® oneAPI Base Toolkit for Linux" as well as the "Intel® FPGA Add-On for oneAPI Base Toolkit", which you can download [here](https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit/download.html#operatingsystem=Linux&#distributions=Web%20and%20Local%20Install&#options=Online). You also need to have a GCC toolchain with support for C++17 features installed and loaded as well the [boost libraries](https://www.boost.org), version 1.29.0 or newer. If your FPGA accelerator card isn't an Intel® PAC, you also need the board support package of your card.
This library requires the "Intel® oneAPI Base Toolkit for Linux", version 2021.1.3 or newer, as well as the corresponding version of the "Intel® FPGA Add-On for oneAPI Base Toolkit", which you can download [here](https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit/download.html#operatingsystem=Linux&#distributions=Web%20and%20Local%20Install&#options=Online). You also need to have a GCC toolchain with support for C++17 features installed and loaded as well the [boost libraries](https://www.boost.org), version 1.29.0 or newer. If your FPGA accelerator card isn't an Intel® PAC, you also need the board support package of your card.

If you're working with [the Noctua super-computer by the Paderborn Center for Parallel Computing](https://pc2.uni-paderborn.de/hpc-services/available-systems/noctua/) and the Nallatech/Bittware 520N Board, you can easily load all required components by executing the following commands:
If you're working with [the Noctua2 super-computer at the Paderborn Center for Parallel Computing](https://pc2.uni-paderborn.de/hpc-services/available-systems/noctua2) and the Nallatech/Bittware 520N Board, you can easily load all required components by executing the following command:

``` bash
source /cm/shared/opt/intel_oneapi/{latest-version}/setvars.sh
module load nalla_pcie compiler/GCC
module load fpga devel intel/oneapi bittware/520n Boost
```

### A basic stencil kernel
Expand Down Expand Up @@ -203,4 +202,4 @@ If you just run `make conway_emu`, an emulation image will be created that can b

### Going further

This example only showed the general way StencilStream is used. More optimised and non-trivial examples can be found in the [examples folder](https://github.com/pc2/StencilStream/tree/master/examples). However, in order to fully understand the way StencilStream works and to optimize your application, you should take a look at [the documentation](https://pc2.github.io/StencilStream/index.html) and especially at the [architecture document](https://pc2.github.io/StencilStream/Architecture.html). Future releases will also feature an optimization guide that discusses the different optimization parameters and gives advice for good designs.
This example only showed the general way StencilStream is used. More optimised and non-trivial examples can be found in the [examples folder](https://github.com/pc2/StencilStream/tree/master/examples). However, in order to fully understand the way StencilStream works and to optimize your application, you should take a look at [the documentation](https://pc2.github.io/StencilStream/index.html) and especially at the [architecture document](https://pc2.github.io/StencilStream/Architecture.html). Future releases will also feature an optimization guide that discusses the different optimization parameters and gives advice for good designs.

0 comments on commit 9a9c8cd

Please sign in to comment.