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.

Sign up for GitHub

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

Jump to bottom

Add CUDA build instructions #1335

Merged
merged 2 commits into from
Jul 25, 2024
Merged

Add CUDA build instructions #1335

merged 2 commits into from
Jul 25, 2024

Conversation

esseivaju
Copy link
Contributor

  • Add a note on how to install Celeritas with GPU support
  • Link to the github.io documentation, browsing RST on GitHub isn't great, it doesn't show included files, broken ref, no TOC, ...
  • Remove broken readthedocs.io link

@esseivaju esseivaju added documentation Documentation, examples, tests, and CI minor Minor internal changes or fixes labels Jul 25, 2024
@esseivaju esseivaju requested a review from sethrj July 25, 2024 01:59
sethrj
sethrj reviewed Jul 25, 2024
View reviewed changes
Copy link
Member

@sethrj sethrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Installation and link changes look good, but the "interactive console session" syntax shouldn't need changing...

README.md Outdated
@@ -49,25 +56,25 @@ As an example, if you have the [Spack][spack] package manager
installed and want to do development on a CUDA system with Volta-class graphics
cards, execute the following steps from within the cloned Celeritas source
directory:
```console
```shell
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should work as is, formatting as an interactive console session.

Git (linguist, see the languages spec) supports it, and Sphinx (pygments, see their lexers) should support it too, either as console or shell-session.

sethrj
sethrj approved these changes Jul 25, 2024
View reviewed changes
Copy link
Member

@sethrj sethrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates! Good to propagate this knowledge along.

@sethrj sethrj enabled auto-merge (squash) July 25, 2024 14:00
@sethrj
Copy link
Member

sethrj commented Jul 25, 2024

Oops, I forgot we don't have the CI do any checking for pure documentation update... I'll force merge this.

@sethrj sethrj disabled auto-merge July 25, 2024 16:10
@sethrj sethrj changed the title Update readme Add CUDA build instructions Jul 25, 2024
@sethrj sethrj merged commit 281913d into celeritas-project:develop Jul 25, 2024
@esseivaju esseivaju deleted the update-readme branch July 25, 2024 16:45
@sethrj sethrj removed the minor Minor internal changes or fixes label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sethrj sethrj sethrj approved these changes

Assignees
No one assigned
Labels
documentation Documentation, examples, tests, and CI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@esseivaju @sethrj