Skip to content

Tutorial - #1439

Open
Yurlungur wants to merge 29 commits into
developfrom
jmm/turorial
Open

Tutorial#1439
Yurlungur wants to merge 29 commits into
developfrom
jmm/turorial

Conversation

@Yurlungur

@Yurlungur Yurlungur commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

PR Summary

In preparation for the Parthenon workshops coming up I finally sat down and wrote a tutorial for how to use parthenon. In the end I did not use gen AI as I wanted to convey very specifically the story I wanted to convey. I also made some minor tweaks to Parthenon guts and scripts to make sure the tutorial worked as intended.

I can't include the project I wrote that the tutorial walks through, as it would be a bit recursive. But if someone else wanted to create it in the parthenon namespace and follow the tutorial so we had a complete version, that wouldn't be unwelcome. That would be a good test my instructions work for someone else.

PR Checklist

  • Code passes cpplint
  • New features are documented.
  • Adds a test for any bugs fixed. Adds tests for new features.
  • Code is formatted
  • Changes are summarized in CHANGELOG.md
  • Change is breaking (API, behavior, ...)
    • Change is additionally added to CHANGELOG.md in the breaking section
    • PR is marked as breaking
    • Short summary API changes at the top of the PR (plus optionally with an automated update/fix script)
  • CI has been triggered on Darwin for performance regression tests.
  • Docs build
  • Any contribution that was created or modified with the assistance of generative AI is disclosed here and in code following the guidelines
  • (@lanl.gov employees) Update copyright on changed files

@Yurlungur Yurlungur self-assigned this Aug 24, 2026
@Yurlungur Yurlungur added the documentation Improvements or additions to documentation label Aug 24, 2026
@Yurlungur

Copy link
Copy Markdown
Collaborator Author

@par-hermes format

@@ -1,4 +1,4 @@
.. par_for:
.. _par_for:

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This was a typo.

plt.colorbar(
pm, label=colorbar, fontsize=fontsize, fraction=0.02, pad=0.04, ax=p
)
plt.colorbar(pm, label=colorbar, fraction=0.02, pad=0.04, ax=p)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

matplotlib api changed. fontsize can't go here anymore.

Comment thread scripts/python/packages/parthenon_tools/parthenon_tools/movie2d.py
Comment thread src/interface/swarm_device_context.hpp
@Yurlungur Yurlungur mentioned this pull request Aug 24, 2026
12 tasks
@Yurlungur

Copy link
Copy Markdown
Collaborator Author

@Yurlungur
Yurlungur enabled auto-merge August 24, 2026 16:29
Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread doc/sphinx/src/tutorial.rst Outdated
@Yurlungur Yurlungur mentioned this pull request Aug 24, 2026
13 tasks
@Yurlungur

Copy link
Copy Markdown
Collaborator Author

@pgrete @c-prather please re-review. It should be updated with your suggestions and the issues we found in the live run.

@c-prather c-prather left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left the changes I had to (one I wanted to) make when updating the compile-able example, and some wording things when going through the text again.

Otherwise LGTM, really excellent stuff and I'm glad we finally have this. Bravo.

Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread doc/sphinx/src/tutorial.rst
Comment thread doc/sphinx/src/tutorial.rst Outdated
Comment thread scripts/python/packages/parthenon_tools/parthenon_tools/movie2d.py
Comment thread src/interface/swarm_device_context.hpp

@lroberts36 lroberts36 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is great!

Comment thread doc/sphinx/src/tutorial.rst
Yurlungur and others added 9 commits September 2, 2026 16:13
Co-authored-by: Cora Prather <cprather@radimant.org>
Co-authored-by: Cora Prather <cprather@radimant.org>
Co-authored-by: Cora Prather <cprather@radimant.org>
Co-authored-by: Cora Prather <cprather@radimant.org>
Co-authored-by: Cora Prather <cprather@radimant.org>
@Yurlungur
Yurlungur disabled auto-merge September 2, 2026 20:21
@Yurlungur
Yurlungur enabled auto-merge September 2, 2026 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants