You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# brotsycl
2
2
3
-
brotsycl is a CLI utility that allows to create .ppm images of the Mandelbrot set, for scientists and artists. Leveraging the SYCL language, it can be run
3
+
brotsycl is a Mandelbrot set image generator, for scientists and artists. Leveraging the SYCL language, it can be run
4
4
on CPUs and GPUs, allowing for very fast computation.
5
5
6
6
## Usage
@@ -15,16 +15,16 @@ It produces a square 1024x1024 image with (-2, -2) bottom-left, and (2, 2) upper
15
15
16
16
After doing the heavy calculations, a buffer file is created. It can be fed to the program with -i to skip the computation phase.
17
17
18
-
There will be an all-architectures executable in releases Soon™. View [#Limitations](#limitations) for more info
18
+
There is an almost-all-architectures executable in [releases](https://github.com/silimotion/brotsycl/releases/latest). It has been tested and worked on AMD HIP GPU systems, and CPUs. Work is ongoing to add support to other architectures. It may or may not work on OpenCL devices. If the executable does not work on one of the supported systems please raise an issue. For more information on support, view [#Limitations](#limitations).
19
19
20
20
## Building
21
21
22
-
You first need a SYCL compiler, such as [OpenSYCL](https://github.com/OpenSYCL/OpenSYCL) or DPC++. If you wish to have gpu acceleration,
22
+
You first need a SYCL compiler, such as [AdaptiveCpp](https://github.com/AdaptiveCpp/AdaptiveCpp) or DPC++. If you wish to have gpu acceleration,
23
23
you'll need the appropiate drivers installed, and compile with a capable compiler.
24
24
25
25
Once you have a functional installation you can compile the project. If using the OpenSYCL compiler, you may compile using the following command:
@@ -72,7 +72,7 @@ These benchmarks were measured using the 'time' utility ("user" tab), and compil
72
72
73
73
## Limitations
74
74
75
-
Due to the very early stage of SYCL compilers, it is hard to get a generic SYCL executable. Work is being done by the OpenSYCL team to
75
+
Due to the very early stage of SYCL compilers, it is hard to get a generic SYCL executable. Work is being done by the AdaptiveCpp team to
76
76
develop the SSCP generic compilation. Until everything is polished enough, it will be difficult to produce a tiny and performant downloadable executable runnable on all architectures.
77
77
78
78
Using the GPU that runs the displays for the calculations may cause freezing. I am investigating this to clarify whether it is a bug in SYCL, the compiler, the program, or intended behaviour.
0 commit comments