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: TaperedPL Details #603

Merged
merged 3 commits into from
May 6, 2024
Merged

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented May 6, 2024

Add more details to the documentation.

Follow-up to #562

@ax3l ax3l added component: documentation Docs, readme and manual component: elements Elements/external fields labels May 6, 2024
@ax3l ax3l requested a review from cemitch99 May 6, 2024 16:36
@ax3l ax3l force-pushed the doc-taper-details branch 3 times, most recently from a4c88c3 to cf6a6ac Compare May 6, 2024 16:43
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. I made more explicit the connection between the field parameters and the user parameters by adding symbols "g" and "Dx" in the user parameter definitions (Remi's comment).

I think we need to make the same changes in "parameters.rst".

Add more details to the documentation.
Added math in k and taper description - python.rst.
Added math in k and taper description - parameters.rst.
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.

@cemitch99 cemitch99 merged commit 6d482e7 into ECP-WarpX:development May 6, 2024
16 checks passed
@ax3l ax3l deleted the doc-taper-details branch May 14, 2024 01:15
@ax3l ax3l added this to the Advanced Methods (SciDAC) milestone May 23, 2024
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 component: elements Elements/external fields
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants