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

Add helper function for Python Twiss input #697

Merged
merged 5 commits into from
Sep 8, 2024
Merged

Add helper function for Python Twiss input #697

merged 5 commits into from
Sep 8, 2024

Conversation

n01r
Copy link
Member

@n01r n01r commented Sep 6, 2024 •
edited
Loading

Close #680

  • add helper function twiss
  • add FODO example run script
  • add CTest
  • add documentation

@n01r
Add helper function for Python Twiss input
a31d263 
- added helper function `twiss`
- added FODO example run script
- added CTest
@n01r n01r requested a review from ax3l September 6, 2024 01:48
@n01r n01r added this to the Sirepo (FY24 SBIR) milestone Sep 6, 2024
@n01r
Copy link
Member Author

n01r commented Sep 6, 2024

This will close #680

@ax3l ax3l added the component: python Python bindings label Sep 6, 2024
@ax3l ax3l self-assigned this Sep 6, 2024
@ax3l ax3l requested a review from cemitch99 September 6, 2024 16:38
cemitch99
cemitch99 approved these changes Sep 6, 2024
View reviewed changes
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 great. (Note one test is failing due to the import on line 21 of init.py.)

@n01r
Copy link
Member Author

n01r commented Sep 6, 2024

Ah, seems like I may need to add # noqa after all.

n01r and others added 3 commits September 6, 2024 17:17
@n01r
Update examples and add Python Twiss input docs
3a8e210
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
d338c31 
for more information, see https://pre-commit.ci
@n01r
Fix failing CI test
a6c1110 
The CI complained that our import of the `twiss` helper function is unused.
But we need it to be available to use it in our examples.
@n01r
Copy link
Member Author

n01r commented Sep 7, 2024

The documentation preview does not seem to render the .. autofunction:: impactx.twiss yet. But here's what it looks like locally.
image

ax3l
ax3l approved these changes Sep 8, 2024
View reviewed changes
Copy link
Member

@ax3l ax3l left a comment

Choose a reason for hiding this comment

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

Very nice, thank you for this! ✨

@ax3l ax3l merged commit d470732 into ECP-WarpX:development Sep 8, 2024
16 checks passed
@ax3l ax3l mentioned this pull request Sep 8, 2024
Open
1 task
@n01r n01r deleted the topic-addPythonHelperForTwissInput branch September 9, 2024 16:20
@n01r n01r mentioned this pull request Sep 11, 2024
Merged
@ax3l
Copy link
Member

ax3l commented Sep 18, 2024

fyi @moellep

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cemitch99 cemitch99 cemitch99 approved these changes

@ax3l ax3l ax3l approved these changes

Assignees

@ax3l ax3l

Labels
component: python Python bindings
Projects
None yet
Milestone
Sirepo (FY24/24 Phase 1 SBIR)
Development

Successfully merging this pull request may close these issues.

Python Distributions: By Twiss
3 participants
@n01r @ax3l @cemitch99