Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add information about simsycl headers to README #41

Open
Pennycook opened this issue Feb 4, 2025 · 1 comment
Open

Add information about simsycl headers to README #41

Pennycook opened this issue Feb 4, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Pennycook
Copy link

The README currently says:

Systems are defined by listing all devices, platforms and their runtime properties in a JSON file.
As a starting point, you can export the built-in system definition via

simsycl::write_system_config("system.json", simsycl::builtin_system);

Trying to follow these instructions gives a compiler error, because the simsycl:: functions aren't pulled in by including <sycl/sycl.hpp>. I had to poke around in the source to figure out that I needed to include simsycl/system.hh as well.

@PeterTh
Copy link
Collaborator

PeterTh commented Feb 4, 2025

Fully agreed, I ran into the same issue myself recently actually.

Note that we are also aware that the current system config mechanism isn't ideal in some circumstances, like setting up 4 or 8 identical GPUs.

@PeterTh PeterTh added the documentation Improvements or additions to documentation label Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants