@@ -13,50 +13,18 @@ There are several ways to run the tutorial notebooks:
13
13
[ ![ Binder] ( https://mybinder.org/badge_logo.svg )] ( https://mybinder.org/v2/gh/fastmachinelearning/hls4ml-tutorial/HEAD )
14
14
15
15
## Conda
16
+ Running the tutorials requires AMD Vitis HLS to be installed, see [ here] ( https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vitis.html ) .
17
+ After the installation, the necessary environmental variables can be set using
18
+ ```
19
+ source /path/to/your/installtion/Xilinx/Vitis_HLS/202X.X/settings64.(c)sh
20
+ ```
21
+
16
22
The Python environment used for the tutorials is specified in the ` environment.yml ` file.
17
23
It can be setup like:
18
24
``` bash
19
25
conda env create -f environment.yml
20
26
conda activate hls4ml-tutorial
21
- ```
22
-
23
- ## Docker without Vivado
24
- Pull the prebuilt image from the GitHub Container Registry:
25
- ``` bash
26
- docker pull ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0:latest
27
- ```
28
-
29
- Follow these steps to build a Docker image that can be used locally, or on a JupyterHub instance.
30
- You can build the image (without Vivado):
31
- ``` bash
32
- docker build https://github.com/fastmachinelearning/hls4ml-tutorial -f docker/Dockerfile
33
- ```
34
- Alternatively, you can clone the repository and build locally:
35
- ``` bash
36
- git clone https://github.com/fastmachinelearning/hls4ml-tutorial
37
- cd hls4ml-tutorial
38
- docker build -f docker/Dockerfile -t ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0:latest .
39
- ```
40
- Then to start the container:
41
- ``` bash
42
- docker run -p 8888:8888 ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0:latest
43
- ```
44
- When the container starts, the Jupyter notebook server is started, and the link to open it in your browser is printed.
45
- You can clone the repository inside the container and run the notebooks.
46
-
47
- ## Docker with Vivado
48
- Pull the prebuilt image from the GitHub Container Registry:
49
- ``` bash
50
- docker pull ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.2:latest
51
- ```
52
-
53
- To build the image with Vivado, run (Warning: takes a long time and requires a lot of disk space):
54
- ``` bash
55
- docker build -f docker/Dockerfile.vivado -t ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.2:latest .
56
- ```
57
- Then to start the container:
58
- ``` bash
59
- docker run -p 8888:8888 ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.2:latest
27
+ source /path/to/your/installtion/Xilinx/Vitis_HLS/202X.X/settings64.(c)sh
60
28
```
61
29
62
30
## Companion material
0 commit comments