trixi-framework / trixi-framework/TrixiParticles.jl

Tutorial Proposal : Analyzing particle transport around adaptive mesh regions with TrixiParticles.jl

Open
#960 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion
Dominant language
Julia
Stars
83
Forks
24
Avg merge
8d 18h
Merged PRs (30d)
3

Description

I would like to create a tutorial on how to simulate and visualize particle transport around adaptive mesh refinement regions using TrixiParticles.jl. This would be helpful for users to understand and learn to apply the library. Specifically, I will be comparing efficiency, accuracy, and ease of use in the tutorial. This would allow for a better understanding of the user experience and make the particle simulations more accessible for new users.

Would this tutorial be good for this project's documentation?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue. Review the project's existing documentation structure first, then define a tutorial covering particle transport around adaptive mesh refinement regions with comparisons of efficiency, accuracy, and ease of use; it is done when that tutorial is complete and suitable for new users.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.