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

[Documentation] Use raw url for image assets #26

Merged
merged 89 commits into from
Jul 26, 2024
Merged

[Documentation] Use raw url for image assets #26

merged 89 commits into from
Jul 26, 2024

Commits on Jun 6, 2024

  1. initial doc add for abstract type BoundaryFunction

    @youwuyou
    youwuyou committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    aab5aa3 View commit details
    Browse the repository at this point in the history

  2. added documentation to add all abstract data types

    @youwuyou
    youwuyou committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    cfea412 View commit details
    Browse the repository at this point in the history

Commits on Jun 9, 2024

  1. added skeleton of documentation for the website to be finished

    @youwuyou
    youwuyou committed Jun 9, 2024
    Configuration menu
    Copy the full SHA
    20192e2 View commit details
    Browse the repository at this point in the history

  2. added concept doc for architectures

    @youwuyou
    youwuyou committed Jun 9, 2024
    Configuration menu
    Copy the full SHA
    4e5a4d4 View commit details
    Browse the repository at this point in the history

  3. finished docstrings for distributed architecture

    @youwuyou
    youwuyou committed Jun 9, 2024
    Configuration menu
    Copy the full SHA
    e11bb71 View commit details
    Browse the repository at this point in the history

Commits on Jun 10, 2024

  1. added concept doc for grids and fields

    @youwuyou
    youwuyou committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    17d7e82 View commit details
    Browse the repository at this point in the history

  2. using : instead of ; for grid cell figure

    @youwuyou
    youwuyou committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    c10934d View commit details
    Browse the repository at this point in the history

  3. finished the FunctionField concept doc

    @youwuyou
    youwuyou committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    93888e2 View commit details
    Browse the repository at this point in the history

Commits on Jun 11, 2024

  1. add set! for IC in field concept doc

    @youwuyou
    youwuyou committed Jun 11, 2024
    Configuration menu
    Copy the full SHA
    1ac100c View commit details
    Browse the repository at this point in the history

Commits on Jun 13, 2024

  1. added short description in readme

    @youwuyou
    youwuyou committed Jun 13, 2024
    Configuration menu
    Copy the full SHA
    781fe13 View commit details
    Browse the repository at this point in the history

  2. added concept doc for task-based parallelism

    @youwuyou
    youwuyou committed Jun 13, 2024
    Configuration menu
    Copy the full SHA
    188a31a View commit details
    Browse the repository at this point in the history

Commits on Jun 14, 2024

  1. Update docs/src/concepts/workers.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 14, 2024
    Configuration menu
    Copy the full SHA
    d59b9de View commit details
    Browse the repository at this point in the history

Commits on Jun 15, 2024

  1. renamed tutorials to examples

    @youwuyou
    youwuyou committed Jun 15, 2024
    Configuration menu
    Copy the full SHA
    7de43f4 View commit details
    Browse the repository at this point in the history

  2. change Tutorials entry in doc content overview to Examples

    @youwuyou
    youwuyou committed Jun 15, 2024
    Configuration menu
    Copy the full SHA
    79235c5 View commit details
    Browse the repository at this point in the history

  3. 95% finished kernels concept doc, remained to detail about performanc… 

    …e consideration by alterning workgroup size etc
    @youwuyou
    youwuyou committed Jun 15, 2024
    Configuration menu
    Copy the full SHA
    21cf1a9 View commit details
    Browse the repository at this point in the history

  4. concept docs reordering

    @youwuyou
    youwuyou committed Jun 15, 2024
    Configuration menu
    Copy the full SHA
    6b8c8ae View commit details
    Browse the repository at this point in the history

  5. changed table of contents

    @youwuyou
    youwuyou committed Jun 15, 2024
    Configuration menu
    Copy the full SHA
    1e80be0 View commit details
    Browse the repository at this point in the history

Commits on Jun 16, 2024

  1. small complement to grid part regarding field dimensions

    @youwuyou
    youwuyou committed Jun 16, 2024
    Configuration menu
    Copy the full SHA
    bdf9b93 View commit details
    Browse the repository at this point in the history

  2. naming consistency

    @youwuyou
    youwuyou committed Jun 16, 2024
    Configuration menu
    Copy the full SHA
    be39ca5 View commit details
    Browse the repository at this point in the history

Commits on Jun 17, 2024

  1. added concept doc for BC, and visualized results from grid scripts

    @youwuyou
    youwuyou committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    3b93d6d View commit details
    Browse the repository at this point in the history

  2. finished the concept doc for grid operators (icl. FD operators, maski… 

    …ng, interpolation)
    @youwuyou
    youwuyou committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    5c6dfdb View commit details
    Browse the repository at this point in the history

  3. clean up

    @youwuyou
    youwuyou committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    0c4e3ee View commit details
    Browse the repository at this point in the history

  4. update docstrings

    @youwuyou
    youwuyou committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    d599e6a View commit details
    Browse the repository at this point in the history

  5. docstring for launcher

    @youwuyou
    youwuyou committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    767668b View commit details
    Browse the repository at this point in the history

  6. docstrings for first order BC structs, set! for fields and function c… 

    …alls for defining vector/tensor fields
    @youwuyou
    youwuyou committed Jun 17, 2024
    Configuration menu
    Copy the full SHA
    56c570f View commit details
    Browse the repository at this point in the history

  7. Update docs/src/concepts/grid_operators.md 

    remove spacing for `V`

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 17, 2024
    Configuration menu
    Copy the full SHA
    abbb13d View commit details
    Browse the repository at this point in the history

  8. Update docs/src/concepts/grid_operators.md 

    remove spacing for `∇V`

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 17, 2024
    Configuration menu
    Copy the full SHA
    e25b34e View commit details
    Browse the repository at this point in the history

Commits on Jun 18, 2024

  1. remove outer_width in the example in kernels.md

    @youwuyou
    youwuyou committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    02184ca View commit details
    Browse the repository at this point in the history

  2. BC example with y-axis pointing upwards

    @youwuyou
    youwuyou committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    58a5272 View commit details
    Browse the repository at this point in the history

  3. added concept explaination of indexing for kernels

    @youwuyou
    youwuyou committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    5f252bb View commit details
    Browse the repository at this point in the history

Commits on Jun 21, 2024

  1. Update docs/src/concepts/fields.md 

    remove unnecessary space

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 21, 2024
    Configuration menu
    Copy the full SHA
    e6c8ce2 View commit details
    Browse the repository at this point in the history

  2. Update docs/src/concepts/fields.md 

    formatting

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 21, 2024
    Configuration menu
    Copy the full SHA
    8daaf2a View commit details
    Browse the repository at this point in the history

Commits on Jun 24, 2024

  1. better KA priority description

    @youwuyou
    youwuyou committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    3e0ad23 View commit details
    Browse the repository at this point in the history

  2. added batched bc explaination

    @youwuyou
    youwuyou committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    a943101 View commit details
    Browse the repository at this point in the history

  3. update the grid operator lerp example

    @youwuyou
    youwuyou committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    e85617f View commit details
    Browse the repository at this point in the history

  4. Update docs/src/concepts/architectures.md 

    changed to better wording

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 24, 2024
    Configuration menu
    Copy the full SHA
    84d0002 View commit details
    Browse the repository at this point in the history

Commits on Jun 25, 2024

  1. Update docs/src/concepts/bc.md 

    changed the ordering of BC for the example case

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jun 25, 2024
    Configuration menu
    Copy the full SHA
    013e722 View commit details
    Browse the repository at this point in the history

  2. removed inaccurate description for batched bc

    @youwuyou
    youwuyou committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    503237c View commit details
    Browse the repository at this point in the history

  3. Merge branch 'yw/test-documentation' of github.com:PTsolvers/Chmy.jl … 

    …into yw/test-documentation
    @youwuyou
    youwuyou committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    576fa73 View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2024

  1. having a clean example overview table to most essential numerical exp… 

    …eriments
    @youwuyou
    youwuyou committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    23f9256 View commit details
    Browse the repository at this point in the history

  2. moved runtests instructions to home, added also an installation guide… 

    … & feature summary
    @youwuyou
    youwuyou committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    fe45578 View commit details
    Browse the repository at this point in the history

  3. skeleton for getting started, where the most essential concepts shall… 

    … be explained
    @youwuyou
    youwuyou committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    00f5768 View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2024

  1. Update docs/src/index.md 

    fixed grammar mistake

Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 13, 2024
    Configuration menu
    Copy the full SHA
    2825fcf View commit details
    Browse the repository at this point in the history

Commits on Jul 15, 2024

  1. installation from a specific branch in home guide

    @youwuyou
    youwuyou committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    9192a5f View commit details
    Browse the repository at this point in the history

Commits on Jul 17, 2024

  1. finished the getting_started section with the 2D diffusion example

    @youwuyou
    youwuyou committed Jul 17, 2024
    Configuration menu
    Copy the full SHA
    ea0c687 View commit details
    Browse the repository at this point in the history

  2. refined the getting started and added it=100 2d diffusion result

    @youwuyou
    youwuyou committed Jul 17, 2024
    Configuration menu
    Copy the full SHA
    5696520 View commit details
    Browse the repository at this point in the history

  3. better BC description for precomputed BC & launch with BC

    @youwuyou
    youwuyou committed Jul 17, 2024
    Configuration menu
    Copy the full SHA
    c0e2de3 View commit details
    Browse the repository at this point in the history

  4. removed the unnecessary launch with BC description as it was detailed… 

    … in BC part
    @youwuyou
    youwuyou committed Jul 17, 2024
    Configuration menu
    Copy the full SHA
    c8d0415 View commit details
    Browse the repository at this point in the history

Commits on Jul 18, 2024

  1. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    c714e52 View commit details
    Browse the repository at this point in the history

  2. coherent description of diffusion coeff with chi, removed unnecessary… 

    … lines
    @youwuyou
    youwuyou committed Jul 18, 2024
    Configuration menu
    Copy the full SHA
    3bcee16 View commit details
    Browse the repository at this point in the history

  3. removed all unnecessary blanks

    @youwuyou
    youwuyou committed Jul 18, 2024
    Configuration menu
    Copy the full SHA
    31d2724 View commit details
    Browse the repository at this point in the history

  4. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    8e4ddee View commit details
    Browse the repository at this point in the history

  5. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    79a4432 View commit details
    Browse the repository at this point in the history

  6. Add favicon

    @luraess
    luraess committed Jul 18, 2024
    Configuration menu
    Copy the full SHA
    3293009 View commit details
    Browse the repository at this point in the history

  7. Merge branch 'yw/test-documentation' of github.com:PTsolvers/Chmy.jl … 

    …into yw/test-documentation
    @luraess
    luraess committed Jul 18, 2024
    Configuration menu
    Copy the full SHA
    d00c86b View commit details
    Browse the repository at this point in the history

  8. Bump version 

    To be checked prior to merge and make sure to bump it wrt current main
    @luraess
    luraess committed Jul 18, 2024
    Configuration menu
    Copy the full SHA
    7424008 View commit details
    Browse the repository at this point in the history

  9. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    fe50443 View commit details
    Browse the repository at this point in the history

  10. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    1ecb7a6 View commit details
    Browse the repository at this point in the history

  11. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    df655a8 View commit details
    Browse the repository at this point in the history

  12. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    b0a7358 View commit details
    Browse the repository at this point in the history

  13. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    959c21d View commit details
    Browse the repository at this point in the history

  14. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    8e664f1 View commit details
    Browse the repository at this point in the history

  15. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    717fd54 View commit details
    Browse the repository at this point in the history

  16. Update docs/src/getting_started.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    44d72b1 View commit details
    Browse the repository at this point in the history

  17. Merge branch 'main' into yw/test-documentation

    @youwuyou
    youwuyou authored Jul 18, 2024
    Configuration menu
    Copy the full SHA
    b86ca2a View commit details
    Browse the repository at this point in the history

Commits on Jul 23, 2024

  1. Move testing to developer documentation

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    4a3ee36 View commit details
    Browse the repository at this point in the history

  2. Add content

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    8cade89 View commit details
    Browse the repository at this point in the history

  3. Remove overview page

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    82946d9 View commit details
    Browse the repository at this point in the history

  4. Update architectures

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    0d302cf View commit details
    Browse the repository at this point in the history

  5. Update boundary conditions

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    4d5d4eb View commit details
    Browse the repository at this point in the history

  6. Update grids section

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    d1c3312 View commit details
    Browse the repository at this point in the history

  7. Update fields section

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    0698d99 View commit details
    Browse the repository at this point in the history

  8. Update grid operations section

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    18fc809 View commit details
    Browse the repository at this point in the history

  9. Move workers to dev docs

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    2299ce3 View commit details
    Browse the repository at this point in the history

  10. Update kernels section

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    1faabff View commit details
    Browse the repository at this point in the history

  11. Add missing articles

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    0c329cc View commit details
    Browse the repository at this point in the history

  12. Remove temperature

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    a79ac1e View commit details
    Browse the repository at this point in the history

  13. Change paths

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    adef64b View commit details
    Browse the repository at this point in the history

  14. Add favicon to assets

    @utkinis
    utkinis committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    b3d3303 View commit details
    Browse the repository at this point in the history

  15. fixed not rendered subscript

    @youwuyou
    youwuyou committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    1372f0e View commit details
    Browse the repository at this point in the history

  16. using Nvidia instead of NVIDIA

    @youwuyou
    youwuyou committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    1080247 View commit details
    Browse the repository at this point in the history

  17. Add minor fixes

    @luraess
    luraess committed Jul 23, 2024
    Configuration menu
    Copy the full SHA
    953ef1f View commit details
    Browse the repository at this point in the history

Commits on Jul 24, 2024

  1. Fix equation numbering

    @utkinis
    utkinis committed Jul 24, 2024
    Configuration menu
    Copy the full SHA
    0f3077f View commit details
    Browse the repository at this point in the history

  2. consistency in g(x, t) => g(x,y,t)

    @youwuyou
    youwuyou committed Jul 24, 2024
    Configuration menu
    Copy the full SHA
    b1ea6af View commit details
    Browse the repository at this point in the history

Commits on Jul 25, 2024

  1. raw url for image assets

    @youwuyou
    youwuyou committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    9d198fb View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into yw/test-documentation

    @youwuyou
    youwuyou authored Jul 25, 2024
    Configuration menu
    Copy the full SHA
    82ef343 View commit details
    Browse the repository at this point in the history

  3. added description for GPU-aware mpi warning

    @youwuyou
    youwuyou committed Jul 25, 2024
    Configuration menu
    Copy the full SHA
    5dc8d17 View commit details
    Browse the repository at this point in the history

Commits on Jul 26, 2024

  1. Update docs/src/concepts/architectures.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 26, 2024
    Configuration menu
    Copy the full SHA
    00c6cb7 View commit details
    Browse the repository at this point in the history

  2. Update docs/src/concepts/architectures.md 

    Co-authored-by: Ludovic Räss <[email protected]>
    @youwuyou @luraess
    youwuyou and luraess authored Jul 26, 2024
    Configuration menu
    Copy the full SHA
    a9f0e61 View commit details
    Browse the repository at this point in the history