Skip to content
Snippets Groups Projects
Commit 2ab77743 authored by Bram Veenboer's avatar Bram Veenboer
Browse files

Update README

parent f7fbd5a7
No related branches found
No related tags found
No related merge requests found
Pipeline #55559 passed
...@@ -11,15 +11,7 @@ _Astronomy and Astrophysics_, 656(A32), pages 1-4, December 2021). ...@@ -11,15 +11,7 @@ _Astronomy and Astrophysics_, 656(A32), pages 1-4, December 2021).
## Brief overview on how to use the Tensor-Core Correlator library: ## Brief overview on how to use the Tensor-Core Correlator library:
Clone the repository (`git clone https://git.astron.nl/RD/tensor-core-correlator.git`) Clone the and build the repository, see below.
Build the library:
```
mkdir build-$(arch)
cd build-$(arch)
cmake ..
make
```
Include `libtcc/Correlator.h`, and link with `libtcc/libtcc.so`. Include `libtcc/Correlator.h`, and link with `libtcc/libtcc.so`.
Create a `tcc::Correlator` object with the number of receivers, channels, etc. Create a `tcc::Correlator` object with the number of receivers, channels, etc.
...@@ -72,6 +64,10 @@ Limitations: ...@@ -72,6 +64,10 @@ Limitations:
(i.e., 32, 16, or 8 for 4-bit, 8-bit, or 16-bit input, respectively). (i.e., 32, 16, or 8 for 4-bit, 8-bit, or 16-bit input, respectively).
## Building, testing, and installation ## Building, testing, and installation
Clone the repository:
```bash
git clone https://git.astron.nl/RD/tensor-core-correlator.git
```
To build and install the project, run: To build and install the project, run:
```bash ```bash
...@@ -94,9 +90,11 @@ make -C build ...@@ -94,9 +90,11 @@ make -C build
make -C build test make -C build test
``` ```
The tests require a GPU. The tests require a GPU.
On the DAS cluster you can request a GPU node and run the tests with the command: On the DAS-6/ASTRON cluster you can request a GPU node and run the tests with the command:
```bash ```bash
srun -N 1 -C gpunode --gres=gpu:1 make -C build test srun -N 1 --gres=gpu:A4000:1 make -C build test
``` ```
Note that in the command above a node with a NVIDIA A4000 GPU is requested, because the tests require a GPU that has tensor cores.
Contact John Romein (romein@astron.nl) to report bugs/feedback Contact John Romein (romein@astron.nl) to report bugs/feedback
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment