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 Jacobi tutorial to documentation #152

Merged
merged 7 commits into from
Jun 14, 2024
Merged

Add Jacobi tutorial to documentation #152

merged 7 commits into from
Jun 14, 2024

Conversation

GeliezaK
Copy link
Collaborator

@GeliezaK GeliezaK commented Jun 6, 2024

Added a tutorial on computing the 1D Jacobi method in parallel with PartitionedArrays to the documentation as a getting started page.

@GeliezaK GeliezaK requested a review from fverdugo June 6, 2024 06:41
Copy link
Owner

@fverdugo fverdugo left a comment

Choose a reason for hiding this comment

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

Hi @GeliezaK

the tutorial looks very good!

The documentation build is failing. Run it locally and try to reproduce the error? Maybe something related to mpi?

@GeliezaK
Copy link
Collaborator Author

GeliezaK commented Jun 6, 2024

Hi @fverdugo,
the issue did not appear when running it locally. So I have worked around it by putting the code that was executed with mpi in a markdown code block.

@fverdugo
Copy link
Owner

fverdugo commented Jun 6, 2024

Hi @GeliezaK

Excellent Job!

Some minor comments:

  • The output of @show and error messages (like when you index ranks[1]) do not show in the final page. Pleas rephrase the corresponding parts taking into account this. E.g, Perhaps remove the @show.

  • Since we plan to add more tutorials (e.g. spmv), we need to create a new section called "Tutorials", and put this tutorial as the first one.

@GeliezaK
Copy link
Collaborator Author

GeliezaK commented Jun 10, 2024

Hi @fverdugo ,
thank you for your comments. I wrapped the errorneous lines in try-catch-blocks, removed the @show, and added the tutorial to a new "Tutorials" section.

@GeliezaK GeliezaK added the gsoc Google Summer of Code label Jun 13, 2024
Copy link
Owner

@fverdugo fverdugo left a comment

Choose a reason for hiding this comment

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

See my minor comment.

Copy link
Owner

Choose a reason for hiding this comment

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

Hi @GeliezaK

just a final (minor comment).

Please remove this .md file from the repo as it is generated automatically.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks! I deleted it.

@fverdugo
Copy link
Owner

@GeliezaK Thanks for this PR!

@fverdugo fverdugo merged commit 11ec789 into master Jun 14, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gsoc Google Summer of Code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants