From 3d71c2d6b875959a047b7e1154f9f0de7e154e67 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Tue, 3 Dec 2024 15:50:21 -0600 Subject: [PATCH 01/10] Update link to contributing/development guidelines --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 26ba506add..87cf2696db 100644 --- a/README.md +++ b/README.md @@ -111,8 +111,8 @@ See the [contribution guide][contributing-guidelines] for the contribution proce [the development guidelines][development-guidelines] for further details on coding in Celeritas, and [the administration guidelines][administration-guidelines] for community standards and roles. -[contributing-guidelines]: https://celeritas-project.github.io/celeritas/user/appendix/development.html#contributing-to-celeritas -[development-guidelines]: https://celeritas-project.github.io/celeritas/user/appendix/development.html#code-development-guidelines +[contributing-guidelines]: https://celeritas-project.github.io/celeritas/user/development/contributing.html +[development-guidelines]: https://celeritas-project.github.io/celeritas/user/development/coding.html [administration-guidelines]: https://celeritas-project.github.io/celeritas/user/appendix/administration.html # Directory structure From 82f5a72013af890324861462ada72858acd1b331 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Tue, 3 Dec 2024 16:00:52 -0600 Subject: [PATCH 02/10] fix typo --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2fc3fb986e..2226eecef2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -118,7 +118,7 @@ Congratulations! .. [resol] When you've fully implemented the reviewer's comment, you may mark it as resolved without commenting. Do not resolve a conversation if you - disagree with the feed: instead, post your view in a follow-on comment and + disagree with the feedback: instead, post your view in a follow-on comment and wait for the reviewer to respond. If you comment, whether to supplement your change or to iterate with the reviewer, please do not resolve the conversation since that makes it hard to find your comment. From f8bc63f16027fb87fdb30e146fe5c19917189207 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Tue, 3 Dec 2024 16:03:26 -0600 Subject: [PATCH 03/10] add trailing new line to make the last text line appear? --- CONTRIBUTING.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2226eecef2..afcaca0791 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -124,3 +124,4 @@ Congratulations! conversation since that makes it hard to find your comment. .. _pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests + From a192d327c6f0d2b19fda004bc9271e96ea5eae8d Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Tue, 3 Dec 2024 16:07:51 -0600 Subject: [PATCH 04/10] add trailing new line to make the last text line appear? --- CONTRIBUTING.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index afcaca0791..6ae739662e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -125,3 +125,4 @@ Congratulations! .. _pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests + From fd54c799e885afa4d1111394bfc4ad937cc64959 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Tue, 3 Dec 2024 16:12:21 -0600 Subject: [PATCH 05/10] Remove unnecessary newline ... all is fine --- CONTRIBUTING.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6ae739662e..2226eecef2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -124,5 +124,3 @@ Congratulations! conversation since that makes it hard to find your comment. .. _pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests - - From 6bfa8b9f0602e600ddef63b9b967e64440bd8a6e Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Wed, 4 Dec 2024 11:19:06 -0600 Subject: [PATCH 06/10] Clarify spack usage --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 87cf2696db..9d1b808d34 100644 --- a/README.md +++ b/README.md @@ -25,16 +25,34 @@ doc` (user) or `ninja doxygen` (developer). # Installation for applications The easiest way to install Celeritas as a library/app is with Spack: -- Follow the first two steps above to install [Spack][spack-start] and set up its CUDA usage. -- Install Celeritas with `spack install celeritas` -- Use `spack load celeritas` to add the installation to your `PATH`. +- Follow this these steps to install [Spack][spack-start]. +```console +# Install Spack +git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git +# Add Spack to the shell environment +# For bash/zsh/sh (See [spack-start] for other shell) +``` +- Install Celeritas with +```console +spack install celeritas +```console +- Add the Celeritas installation to your `PATH` with: +```console +spack load celeritas +``` To install a GPU-enabled Celeritas build, you might have to make sure that VecGeom is also built with CUDA support if installing `celeritas+vecgeom`, which is the default geometry. -To do so, set the following configuration: +To do so, aet Spack up its CUDA usage: ```console +. spack/share/spack/setup-env.sh +# Set up CUDA (optional) +$ spack external find cuda # Replace cuda_arch=80 with your target architecture -$ spack config add packages:vecgeom:variants:"cxxstd=17 +cuda cuda_arch=80" +$ spack config add packages:all:variants:"cxxstd=17 +cuda cuda_arch=80" +``` +and install Celeritas with this configuration: +```console $ spack install celeritas +cuda cuda_arch=80 ``` @@ -62,7 +80,7 @@ $ spack external find cuda # Install celeritas dependencies $ spack env create celeritas scripts/spack.yaml $ spack env activate celeritas -$ spack config add packages:all:variants:"cxxstd=17 +cuda cuda_arch=70" +$ spack config add packages:all:variants:"cxxstd=17 +cuda cuda_arch=80" $ spack install # Configure, build, and test $ ./build.sh base From ca063cd4c83ae8594f332e34f8fefc7cd7441db4 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Wed, 4 Dec 2024 11:19:19 -0600 Subject: [PATCH 07/10] Remove jenkins mention --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d1b808d34..cc403f5655 100644 --- a/README.md +++ b/README.md @@ -115,12 +115,11 @@ Geant4: Since we compile with extra warning flags and avoid non-portable code, most other compilers *should* work. -The full set of configurations is viewable on CI platforms ([Jenkins][jenkins] and [GitHub Actions][gha]). +The full set of configurations is viewable on CI platform [GitHub Actions][gha]). Compatibility fixes that do not cause newer versions to fail are welcome. [spack]: https://github.com/spack/spack [install]: https://celeritas-project.github.io/celeritas/user/main/installation.html -[jenkins]: https://cloud.cees.ornl.gov/jenkins-ci/job/celeritas/job/develop [gha]: https://github.com/celeritas-project/celeritas/actions # Development From 49a2174f3f5205c7f2ac4754c23486a58d50d4b5 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Wed, 4 Dec 2024 12:27:52 -0600 Subject: [PATCH 08/10] Fix typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cc403f5655..e4f65589ed 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ doc` (user) or `ninja doxygen` (developer). # Installation for applications The easiest way to install Celeritas as a library/app is with Spack: -- Follow this these steps to install [Spack][spack-start]. +- Follow these steps to install [Spack][spack-start]. ```console # Install Spack git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git @@ -43,7 +43,7 @@ spack load celeritas To install a GPU-enabled Celeritas build, you might have to make sure that VecGeom is also built with CUDA support if installing `celeritas+vecgeom`, which is the default geometry. -To do so, aet Spack up its CUDA usage: +To do so, set Spack up its CUDA usage: ```console . spack/share/spack/setup-env.sh # Set up CUDA (optional) From f60f5b3f86ed7fa8f3ff6d44ca834c12b2575afd Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Wed, 4 Dec 2024 12:38:37 -0600 Subject: [PATCH 09/10] Mention the citation data duplication --- CITATION.cff | 3 +++ README.md | 2 ++ 2 files changed, 5 insertions(+) diff --git a/CITATION.cff b/CITATION.cff index ddbd1b0cf2..7fdcb5418c 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -17,6 +17,9 @@ # doi = {10.1051/epjconf/202429511005} # } # +# Note: This information is also present in the README.md and needs to +# kept in sync. +# # (CFF): cff-version: 1.2.0 diff --git a/README.md b/README.md index e4f65589ed..7864559884 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,8 @@ details on coding in Celeritas, and [the administration guidelines][administrati # Citing Celeritas + + If using Celeritas in your work, we ask that you cite the following article: > Johnson, Seth R., Amanda Lund, Philippe Canal, Stefano C. Tognini, Julien Esseiva, Soon Yung Jun, Guilherme Lima, et al. 2024. “Celeritas: Accelerating Geant4 with GPUs.” EPJ Web of Conferences 295:11005. https://doi.org/10.1051/epjconf/202429511005. From 3046a9fa6ac144cb870f4719f430d7a12756c5a0 Mon Sep 17 00:00:00 2001 From: Philippe Canal Date: Wed, 4 Dec 2024 16:14:57 -0600 Subject: [PATCH 10/10] Additional spack add config info --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7864559884..0331e59b33 100644 --- a/README.md +++ b/README.md @@ -46,16 +46,26 @@ support if installing `celeritas+vecgeom`, which is the default geometry. To do so, set Spack up its CUDA usage: ```console . spack/share/spack/setup-env.sh -# Set up CUDA (optional) +# Set up CUDA $ spack external find cuda -# Replace cuda_arch=80 with your target architecture +# Optionally set the default configuration. Replace "cuda_arch=80" +# with your target architecture $ spack config add packages:all:variants:"cxxstd=17 +cuda cuda_arch=80" ``` and install Celeritas with this configuration: ```console +$ spack install celeritas +``` +If Celeritas was installed with a different configuration do +```console +$ spack install --fresh celeritas +``` +If you need to set a default configuration +```console $ spack install celeritas +cuda cuda_arch=80 ``` + Then see the "Downstream usage as a library" section of the [installation documentation][install] for how to use Celeritas in your application or framework.