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

[Documentation] Use raw url for image assets #26

Merged
merged 89 commits into from
Jul 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
aab5aa3
initial doc add for abstract type BoundaryFunction
youwuyou Jun 6, 2024
cfea412
added documentation to add all abstract data types
youwuyou Jun 6, 2024
20192e2
added skeleton of documentation for the website to be finished
youwuyou Jun 9, 2024
4e5a4d4
added concept doc for architectures
youwuyou Jun 9, 2024
e11bb71
finished docstrings for distributed architecture
youwuyou Jun 9, 2024
17d7e82
added concept doc for grids and fields
youwuyou Jun 10, 2024
c10934d
using : instead of ; for grid cell figure
youwuyou Jun 10, 2024
93888e2
finished the FunctionField concept doc
youwuyou Jun 10, 2024
1ac100c
add set! for IC in field concept doc
youwuyou Jun 11, 2024
781fe13
added short description in readme
youwuyou Jun 13, 2024
188a31a
added concept doc for task-based parallelism
youwuyou Jun 13, 2024
d59b9de
Update docs/src/concepts/workers.md
youwuyou Jun 14, 2024
7de43f4
renamed tutorials to examples
youwuyou Jun 15, 2024
79235c5
change Tutorials entry in doc content overview to Examples
youwuyou Jun 15, 2024
21cf1a9
95% finished kernels concept doc, remained to detail about performanc…
youwuyou Jun 15, 2024
6b8c8ae
concept docs reordering
youwuyou Jun 15, 2024
1e80be0
changed table of contents
youwuyou Jun 15, 2024
bdf9b93
small complement to grid part regarding field dimensions
youwuyou Jun 16, 2024
be39ca5
naming consistency
youwuyou Jun 16, 2024
3b93d6d
added concept doc for BC, and visualized results from grid scripts
youwuyou Jun 17, 2024
5c6dfdb
finished the concept doc for grid operators (icl. FD operators, maski…
youwuyou Jun 17, 2024
0c4e3ee
clean up
youwuyou Jun 17, 2024
d599e6a
update docstrings
youwuyou Jun 17, 2024
767668b
docstring for launcher
youwuyou Jun 17, 2024
56c570f
docstrings for first order BC structs, set! for fields and function c…
youwuyou Jun 17, 2024
abbb13d
Update docs/src/concepts/grid_operators.md
youwuyou Jun 17, 2024
e25b34e
Update docs/src/concepts/grid_operators.md
youwuyou Jun 17, 2024
02184ca
remove outer_width in the example in kernels.md
youwuyou Jun 18, 2024
58a5272
BC example with y-axis pointing upwards
youwuyou Jun 18, 2024
5f252bb
added concept explaination of indexing for kernels
youwuyou Jun 18, 2024
e6c8ce2
Update docs/src/concepts/fields.md
youwuyou Jun 21, 2024
8daaf2a
Update docs/src/concepts/fields.md
youwuyou Jun 21, 2024
3e0ad23
better KA priority description
youwuyou Jun 24, 2024
a943101
added batched bc explaination
youwuyou Jun 24, 2024
e85617f
update the grid operator lerp example
youwuyou Jun 24, 2024
84d0002
Update docs/src/concepts/architectures.md
youwuyou Jun 24, 2024
013e722
Update docs/src/concepts/bc.md
youwuyou Jun 25, 2024
503237c
removed inaccurate description for batched bc
youwuyou Jun 25, 2024
576fa73
Merge branch 'yw/test-documentation' of github.com:PTsolvers/Chmy.jl …
youwuyou Jun 25, 2024
23f9256
having a clean example overview table to most essential numerical exp…
youwuyou Jul 12, 2024
fe45578
moved runtests instructions to home, added also an installation guide…
youwuyou Jul 12, 2024
00f5768
skeleton for getting started, where the most essential concepts shall…
youwuyou Jul 12, 2024
2825fcf
Update docs/src/index.md
youwuyou Jul 13, 2024
9192a5f
installation from a specific branch in home guide
youwuyou Jul 15, 2024
ea0c687
finished the getting_started section with the 2D diffusion example
youwuyou Jul 17, 2024
5696520
refined the getting started and added it=100 2d diffusion result
youwuyou Jul 17, 2024
c0e2de3
better BC description for precomputed BC & launch with BC
youwuyou Jul 17, 2024
c8d0415
removed the unnecessary launch with BC description as it was detailed…
youwuyou Jul 17, 2024
c714e52
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
3bcee16
coherent description of diffusion coeff with chi, removed unnecessary…
youwuyou Jul 18, 2024
31d2724
removed all unnecessary blanks
youwuyou Jul 18, 2024
8e4ddee
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
79a4432
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
3293009
Add favicon
luraess Jul 18, 2024
d00c86b
Merge branch 'yw/test-documentation' of github.com:PTsolvers/Chmy.jl …
luraess Jul 18, 2024
7424008
Bump version
luraess Jul 18, 2024
fe50443
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
1ecb7a6
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
df655a8
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
b0a7358
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
959c21d
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
8e664f1
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
717fd54
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
44d72b1
Update docs/src/getting_started.md
youwuyou Jul 18, 2024
b86ca2a
Merge branch 'main' into yw/test-documentation
youwuyou Jul 18, 2024
4a3ee36
Move testing to developer documentation
utkinis Jul 23, 2024
8cade89
Add content
utkinis Jul 23, 2024
82946d9
Remove overview page
utkinis Jul 23, 2024
0d302cf
Update architectures
utkinis Jul 23, 2024
4d5d4eb
Update boundary conditions
utkinis Jul 23, 2024
d1c3312
Update grids section
utkinis Jul 23, 2024
0698d99
Update fields section
utkinis Jul 23, 2024
18fc809
Update grid operations section
utkinis Jul 23, 2024
2299ce3
Move workers to dev docs
utkinis Jul 23, 2024
1faabff
Update kernels section
utkinis Jul 23, 2024
0c329cc
Add missing articles
utkinis Jul 23, 2024
a79ac1e
Remove temperature
utkinis Jul 23, 2024
adef64b
Change paths
utkinis Jul 23, 2024
b3d3303
Add favicon to assets
utkinis Jul 23, 2024
1372f0e
fixed not rendered subscript
youwuyou Jul 23, 2024
1080247
using Nvidia instead of NVIDIA
youwuyou Jul 23, 2024
953ef1f
Add minor fixes
luraess Jul 23, 2024
0f3077f
Fix equation numbering
utkinis Jul 24, 2024
b1ea6af
consistency in g(x, t) => g(x,y,t)
youwuyou Jul 24, 2024
9d198fb
raw url for image assets
youwuyou Jul 25, 2024
82ef343
Merge branch 'main' into yw/test-documentation
youwuyou Jul 25, 2024
5dc8d17
added description for GPU-aware mpi warning
youwuyou Jul 25, 2024
00c6cb7
Update docs/src/concepts/architectures.md
youwuyou Jul 26, 2024
a9f0e61
Update docs/src/concepts/architectures.md
youwuyou Jul 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/concepts/architectures.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ For advanced users, we provide a function `activate!(arch; priority)` for specif

Our distributed architecture builds upon the abstraction of having GPU clusters that build on the same GPU architecture. Note that in general, GPU clusters may be equipped with hardware from different vendors, incorporating different types of GPUs to exploit their unique capabilities for specific tasks.

!!! warning "GPU-Aware MPI Required for Distributed Module"
youwuyou marked this conversation as resolved.
Show resolved Hide resolved
The `Distributed` module currently only supports [GPU-aware MPI](https://www.open-mpi.org/faq/?category=runcuda) when a GPU backend is selected for multi-GPU computations. For the `Distributed` module to function properly, any GPU-aware MPI library installation shall be used. Otherwise, a segmentation fault will occur.
youwuyou marked this conversation as resolved.
Show resolved Hide resolved


To make the `Architecture` object aware of MPI topology, user can pass an MPI communicator object and dimensions of the Cartesian topology to the `Arch` constructor:

```julia
Expand Down