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 documentation #87

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Add documentation #87

merged 1 commit into from
Aug 27, 2024

Conversation

Sbozzolo
Copy link
Member

ClimaComms is an important package in the CliMA ecosystem. In particular, it controls how users select whether to run their simulations on CPU or GPUs. It also introduces the concepts of device and context that are seen everywhere in our codes. In this PR, I try to start filling this gap.

`Device`s identify a specific type of computing hardware (e.g., a CPU/a NVidia
GPU, et cetera). The `Device`s implemented are
- [`CPUSingleThreaded`](@ref), for a CPU core with a single thread;
- [`CUDADevice`](@ref), for a single CPU core.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- [`CUDADevice`](@ref), for a single CPU core.
- [`CUDADevice`](@ref), for a single CUDA device.

Copy link
Member

@charleskawczynski charleskawczynski left a comment

Choose a reason for hiding this comment

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

This is a nice set of improvements and documentation, thanks @Sbozzolo!

@Sbozzolo Sbozzolo merged commit 23dbb6f into main Aug 27, 2024
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants