Collective Effects Config in Dashboard #690

proy30 · 2024-08-29T02:23:42Z

PR adds in Space Charge and CSR configuration for users.

TODO:

Resolves #665

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py

proy30 · 2024-09-05T01:26:26Z

UI as of 9/4/24 - 6:25pm PST:

src/python/impactx/dashboard/Input/generalFunctions.py

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py

src/python/impactx/dashboard/Analyze/plot_PhaseSpaceProjections/phaseSpace.py

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py

for more information, see https://pre-commit.ci

folder name is still called 'csrConfiguration'

last step is to connect to simulation

prob_relative values are required to decrease with increasing index

No validation yet and not yet connected to simulation

Space charge/csr simulation content did not merge in correctly originally, this fixes it.

for more information, see https://pre-commit.ci

…ace_charge_configuration

…y30/impactx into dashboard/space_charge_configuration

csr_bins int and positive number

to ensure that users cannot run a simulation when inputs have errors

EZoni · 2024-11-08T00:24:47Z

src/python/impactx/dashboard/simulation.py

+        sim.blocking_factor_x = [state.blocking_factor_x]
+        sim.blocking_factor_y = [state.blocking_factor_y]
+        sim.blocking_factor_z = [state.blocking_factor_z]


I can't remember how this works on the AMReX end, so just to double check, do these have to be single-element lists or can they be simply integers?

Looking at this, it looks like this can be a single integer. Indeed, we use a single integer in this example. Unfortunately the ImpactX documentation does not appear to address the blocking factor, so this needs to be updated.

EZoni · 2024-11-08T00:27:41Z

src/python/impactx/dashboard/Toolbar/exportTemplate.py

Not sure if this is a git display issue, but the indentation of the function body for build_space_charge_or_csr seems off. Could you double check?

EZoni · 2024-11-08T00:34:40Z

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py

+                            with vuetify.VCol(cols=6, classes="py-0"):
+                                vuetify.VTextField(
+                                    label="MLMG Relative Tolerance",
+                                    v_model=("mlmg_relative_tolerance",),


In one discussion in the Trame repo, I was told that one could use v_model_number as well (on top of type="number") and that it could render numbers better when it comes to formatting.

I did try it on my end without noticing any significant improvement, but maybe you could try it as well.

For reference, here's the comment where this was mentioned: Kitware/trame#599 (reply in thread).

EZoni · 2024-11-08T00:42:42Z

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py

+    if state.poisson_solver == "fft":
+        state.prob_relative = [1.1] + [0.0] * (num_prob_relative_fields - 1)
+    elif state.poisson_solver == "multigrid":
+        state.prob_relative = [3.1] + [0.0] * (num_prob_relative_fields - 1)
+    else:
+        state.prob_relative = [0.0] * num_prob_relative_fields


Question for both you and @cemitch99, should we add a comment about the numbers that appear here (e.g., 1.1, 3.1, etc.)? I'm not too familiar with the context here, so I'm not sure if the meaning of these numbers should be clarified.

Those numbers in prob_relative specify the size of the grid relative to the size of the beam, and are documented here and here. Maybe some of the input parameters should include links to the documentation?

cemitch99

This looks good to me. We can discuss a little when we chat today.

proy30 added component: dashboard our browser based trame dashboard component: space charge Space charge & potential solver labels Aug 29, 2024

proy30 marked this pull request as draft August 29, 2024 02:24

proy30 self-assigned this Aug 29, 2024

ax3l self-requested a review August 29, 2024 05:46

github-advanced-security bot found potential problems Sep 1, 2024

View reviewed changes

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py Fixed Show resolved Hide resolved

ax3l reviewed Sep 5, 2024

View reviewed changes

ax3l changed the title ~~[WIP] Space Charge Configuration~~ [WIP] Collective Effects Config in Dashboard Sep 5, 2024

ax3l added the component: CSR coherent synchrotron radiation models label Sep 5, 2024

proy30 force-pushed the dashboard/space_charge_configuration branch from d6d3cb1 to c08a1be Compare September 6, 2024 17:19

proy30 commented Sep 13, 2024

View reviewed changes

src/python/impactx/dashboard/Analyze/plot_PhaseSpaceProjections/phaseSpace.py Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Sep 26, 2024

View reviewed changes

src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py Fixed Show fixed Hide fixed

ax3l mentioned this pull request Oct 2, 2024

Added export functionality for user inputs in dashboard #719

Merged

proy30 mentioned this pull request Oct 21, 2024

Change distribution default parameters to Twiss in dashboard #748

Merged

4 tasks

proy30 and others added 15 commits October 24, 2024 08:36

Added initial space charge UI with basic compatibility with simulation

d8f458c

[pre-commit.ci] auto fixes from pre-commit.com hooks

bc6ac53

for more information, see https://pre-commit.ci

Connected max_level and poisson_solver to simulation

245ca67

prob_relative simulation functionality added

0fd00f4

Update code structuring

6de4c5d

rename variables

deab4ff

Moved input cards

8ac0134

code structure adjustment

87f6117

Added space charge documentation

6dd9df2

Added CSR configuration

a4967d3

Rename 'CSR Configuration' to 'CSR' for UI and code

cc7796c

folder name is still called 'csrConfiguration'

Connect csr_bins to simulation

4d55002

Updated UI look and minor code structure

26658e8

Add initial validation for Space Charge

2dd9313

update simulation code & change Vcombobox to vSelect

8c4d341

proy30 added 13 commits October 24, 2024 08:38

Update default n_cell

60824ee

particle_shape placed in CSR

7f78b96

Added blocking_factor to UI, no functionality

41639c4

Added blocking_factor defaults

c58057f

Added blocking_factor functionality

74e0680

last step is to connect to simulation

Update default values for space charge

2e17299

Updated prob_relative validation

12c8681

prob_relative values are required to decrease with increasing index

Connected blocking_factor to simulation

86e4c07

Add multigrid-specific numerical options

f94bcdc

No validation yet and not yet connected to simulation

Adjust UI formatting

5b0327c

Update export_template for space charge and csr

dcdb8fe

Updated default for blocking_factor xyz

c00c91f

Fixed simulation.py after merge

774b365

Space charge/csr simulation content did not merge in correctly originally, this fixes it.

proy30 force-pushed the dashboard/space_charge_configuration branch from 2ddadf9 to 774b365 Compare October 24, 2024 15:41

pre-commit-ci bot and others added 8 commits October 24, 2024 15:43

[pre-commit.ci] auto fixes from pre-commit.com hooks

ccef469

for more information, see https://pre-commit.ci

Merge remote-tracking branch 'mainline/development' into dashboard/sp…

6cadc74

…ace_charge_configuration

Merge branch 'dashboard/space_charge_configuration' of github.com:pro…

0397f60

…y30/impactx into dashboard/space_charge_configuration

Update validation for n_cell and blocking_factor

5d1d771

Updated ui format

2afaa13

Add csr validation

6a60bec

csr_bins int and positive number

Update simulation station function

571ebd9

to ensure that users cannot run a simulation when inputs have errors

Merge branch 'development' into dashboard/space_charge_configuration

f6eea78

proy30 requested review from cemitch99 and EZoni November 7, 2024 05:39

proy30 changed the title ~~[WIP] Collective Effects Config in Dashboard~~ Collective Effects Config in Dashboard Nov 7, 2024

EZoni reviewed Nov 8, 2024

View reviewed changes

cemitch99 approved these changes Nov 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Collective Effects Config in Dashboard #690

Collective Effects Config in Dashboard #690

proy30 commented Aug 29, 2024 •

edited

Loading

proy30 commented Sep 5, 2024

EZoni Nov 8, 2024

cemitch99 Nov 8, 2024 •

edited

Loading

EZoni Nov 8, 2024

EZoni Nov 8, 2024

EZoni Nov 8, 2024

cemitch99 Nov 8, 2024

cemitch99 left a comment

Collective Effects Config in Dashboard #690

Are you sure you want to change the base?

Collective Effects Config in Dashboard #690

Conversation

proy30 commented Aug 29, 2024 • edited Loading

proy30 commented Sep 5, 2024

EZoni Nov 8, 2024

Choose a reason for hiding this comment

cemitch99 Nov 8, 2024 • edited Loading

Choose a reason for hiding this comment

EZoni Nov 8, 2024

Choose a reason for hiding this comment

EZoni Nov 8, 2024

Choose a reason for hiding this comment

EZoni Nov 8, 2024

Choose a reason for hiding this comment

cemitch99 Nov 8, 2024

Choose a reason for hiding this comment

cemitch99 left a comment

Choose a reason for hiding this comment

proy30 commented Aug 29, 2024 •

edited

Loading

cemitch99 Nov 8, 2024 •

edited

Loading