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

Improve readability of PICMI introduction #5022

Open
BrianMarre opened this issue Aug 8, 2024 · 0 comments
Open

Improve readability of PICMI introduction #5022

BrianMarre opened this issue Aug 8, 2024 · 0 comments
Assignees
@BrianMarre
Labels
documentation regarding documentation or wiki discussions good first issue signal new contributors where they can start PICMI pypicongpu and picmi related refactoring code change to improve performance or to unify a concept but does not change public API

Comments

@BrianMarre
Copy link
Member

The introduction to using PICMI with PIConGPU contains the relatively long LWFA example as a wall of text lacking a detailed explanation.
The example should be moved to a separate page and discussed in more detail.
@BrianMarre BrianMarre changed the title Improve readability of example scripts given in PICMI documentation introduction Improve readability of PICMI introduction Aug 8, 2024
@steindev steindev added documentation regarding documentation or wiki discussions refactoring code change to improve performance or to unify a concept but does not change public API good first issue signal new contributors where they can start PICMI pypicongpu and picmi related labels Aug 13, 2024
@BrianMarre BrianMarre mentioned this issue Aug 27, 2024
Draft
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@BrianMarre BrianMarre

Labels
documentation regarding documentation or wiki discussions good first issue signal new contributors where they can start PICMI pypicongpu and picmi related refactoring code change to improve performance or to unify a concept but does not change public API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steindev @BrianMarre