Shamrock is a general purpose HPC hydrodynamics simulation code focused on astrophysical contexts. The whole code is C++17 by default, and all accelerated parts are done using SYCL, which can be directly compiled directly to native CUDA, ROCM, OpenMP, OpenCL and much more. Shamrock also supports multiple GPUs and Heterogeneous clusters using MPI.
This code aims to be Modern, Modular, Fast, Portable.
- Shamrock docker :
docker run -it --platform=linux/amd64 ghcr.io/shamrock-code/shamrock:latest-oneapi
We provide both a book like documentation and the more classic doxygen style for more details about the sources
- The documentation is available here: Shamrock documentation
The whole getting started guide can be found here: Getting started
Note that a convenient way to pull the Shamrock repo is the following command to also pull the submodules:
git clone --recurse-submodules https://github.com/Shamrock-code/Shamrock.gitJoin us on Discord, or Slack! Alternatively, open a discussion or issue in this repository.
Shamrock accept contributions through github pull request :
- Code contributions via Pull request
- Documentation contributions via Pull request
- Issue report & feature requests via Github issues
If you want to contribute please fork the code and submit your pull requests from your fork.
| Compiler config | Support |
|---|---|
| DPC++ CUDA | |
| DPC++ ROCM | |
| AdaptiveCPP OpenMP | |
| AdaptiveCPP ROCM | |
| AdaptiveCPP CUDA | |
| AdaptiveCPP SSCP |
Shamrock is licensed under the CeCILL Free Software License Agreement v2.1. See License (french version) or License (english version) for more details.
Copyright 2021-2024 Timothée David--Cléris
SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1