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

Mode: Reference Orbit Tracking #831

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Mode: Reference Orbit Tracking #831

merged 1 commit into from
Feb 7, 2025

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Feb 7, 2025 •
edited
Loading

Add a simulation mode that only tracks the reference orbit. Close #622

  • implementation
  • documentation
  • example(s): follow-up PR(s)

@ax3l
Mode: Reference Orbit Tracking
71d17f8 
Add a simulation mode that only tracks the reference orbit.
@ax3l ax3l added the component: core Core ImpactX functionality label Feb 7, 2025
@ax3l ax3l added this to the Sirepo (FY24/24 Phase 1 SBIR) milestone Feb 7, 2025
@ax3l ax3l requested a review from cemitch99 February 7, 2025 07:11
cemitch99
cemitch99 approved these changes Feb 7, 2025
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.

Beautiful. I also tested this on ~5 examples of different types--both app and Python input--and everything works.

@ax3l
Copy link
Member Author

ax3l commented Feb 7, 2025

Yay!! Do you want to push the examples into this PR or do you want to do a follow-up? :)

@ax3l
Copy link
Member Author

ax3l commented Feb 7, 2025

(I can also add the examples, I just want to sync with you which ones to pick first.)

@cemitch99
Copy link
Member

cemitch99 commented Feb 7, 2025 •
edited
Loading

Hm. I'm not sure yet what examples would be the most useful for CI and for illustration. It might be better to come up with something new and interesting that uses this feature. It's ok with me if we do this as a follow-up, if you're comfortable with that.

Otherwise, we're just repeating existing examples in a different mode.

@ax3l
Copy link
Member Author

ax3l commented Feb 7, 2025

Agreed, sounds good to me.

@ax3l ax3l merged commit 0a02856 into BLAST-ImpactX:development Feb 7, 2025
16 checks passed
@ax3l ax3l deleted the topic-mode-ref-orbit branch February 7, 2025 20:54
ax3l
ax3l commented Feb 7, 2025
View reviewed changes
docs/source/usage/python.rst
@@ -233,6 +233,10 @@ Collective Effects & Overall Simulation Parameters

Run the envelope tracking simulation loop.

.. py:method:: track_reference()
Copy link
Member Author

Choose a reason for hiding this comment

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

Opps, ref argument missing.

Copy link
Member Author

Choose a reason for hiding this comment

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

Will push a fix

Copy link
Member

Choose a reason for hiding this comment

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

Oh, yes I ran this, but I missed that the argument was missing in the doc here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed the API after the first doc draft and forgot to add this. Fixed now via dfe55da :)

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

Assignees

@cemitch99 cemitch99

Labels
component: core Core ImpactX functionality tracking: reference orbit
Projects
None yet
Milestone
Sirepo (FY24/24 Phase 1 SBIR)
Development

Successfully merging this pull request may close these issues.

Run Mode: Only Reference Particle
2 participants
@ax3l @cemitch99