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

Doc: Intro Update #692

Merged
merged 3 commits into from
Sep 5, 2024
Merged

Doc: Intro Update #692

merged 3 commits into from
Sep 5, 2024

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Aug 30, 2024

Updated the intro paragraphs with ideas we discussed in the weekly meeting.

@ax3l ax3l added the component: documentation Docs, readme and manual label Aug 30, 2024
@jlvay
Copy link
Member

jlvay commented Aug 30, 2024

Looks good! A couple of comments/suggestions:

  • remove "is" in "ImpactX is runs"
  • perhaps add "(with time as the independent variable)" after "general particle-in-cell code"?

Updated the intro paragraphs with ideas we discussed in the weekly meeting.
@ax3l
Copy link
Member Author

ax3l commented Aug 30, 2024

Thanks, updated :)

Copy link
Member

@cemitch99 cemitch99 left a comment

Choose a reason for hiding this comment

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

This looks good to me. I suggest that there is a follow-up paragraph reproducing some of the text from the IMPACT-Z description (most importantly, examples of applications), an stating explicitly that tracking methods are symplectic. I can contribute this if we agree on where it should be located.

@ax3l
Copy link
Member Author

ax3l commented Sep 4, 2024

Thanks, @cemitch99! Oh yes, I forgot that we wanted to reuse text from the readme in https://github.com/impact-lbl/IMPACT-Z.

Feel free to contribute here or we merge and do a follow-up PR to add more. I think in the As a beam dynamics code, ImpactX ... could be a good paragraph to extend with applications and symplectic properties.

docs/source/index.rst Outdated Show resolved Hide resolved
Co-authored-by: Chad Mitchell <46825199+cemitch99@users.noreply.github.com>
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
@ax3l ax3l merged commit e784039 into ECP-WarpX:development Sep 5, 2024
16 checks passed
@ax3l ax3l deleted the doc-update-intro branch September 5, 2024 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants