Introduce sim.track_particles()

We will have multiple ways to evolve the sim soon (particles, only ref particle, only linear push of covariance matrix), so it is time to rename our central loop. For now, `sim.evolve()` just calls the `sim.track_particles()` logic.
ax3l · Oct 11, 2024 · f174650 · f174650
1 parent 23b2808
commit f174650
Show file tree

Hide file tree

Showing 68 changed files with 90 additions and 72 deletions.
diff --git a/docs/source/usage/python.rst b/docs/source/usage/python.rst
@@ -215,7 +215,11 @@ Collective Effects & Overall Simulation Parameters
 
    .. py:method:: evolve()
 
-      Run the main simulation loop for a number of steps.
+      Run the main simulation loop (deprecated, use ``track_particles``)
+
+   .. py:method:: track_particles()
+
+      Run the particle tracking simulation loop.
 
    .. py:method:: resize_mesh()
 

diff --git a/examples/achromatic_spectrometer/run_spectrometer.py b/examples/achromatic_spectrometer/run_spectrometer.py
@@ -78,7 +78,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/alignment/run_alignment.py b/examples/alignment/run_alignment.py
@@ -55,7 +55,7 @@
 sim.lattice.extend(lattice)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/aperture/run_aperture.py b/examples/aperture/run_aperture.py
@@ -63,7 +63,7 @@
 )
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/apochromatic/run_apochromatic.py b/examples/apochromatic/run_apochromatic.py
@@ -69,7 +69,7 @@
 sim.lattice.extend(lattice_line)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/apochromatic/run_apochromatic_pl.py b/examples/apochromatic/run_apochromatic_pl.py
@@ -108,7 +108,7 @@
 sim.lattice.extend(lattice_line)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/cfbend/run_cfbend.py b/examples/cfbend/run_cfbend.py
@@ -59,7 +59,7 @@
 sim.lattice.extend(bend)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/cfbend/run_cfbend_madx.py b/examples/cfbend/run_cfbend_madx.py
@@ -46,7 +46,7 @@
 sim.lattice.load_file("chicane.madx", nslice=25)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/cfchannel/run_cfchannel.py b/examples/cfchannel/run_cfchannel.py
@@ -53,7 +53,7 @@
 )
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/cfchannel/run_cfchannel_10nC_fft.py b/examples/cfchannel/run_cfchannel_10nC_fft.py
@@ -59,7 +59,7 @@
 )
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/cfchannel/run_cfchannel_10nC_mlmg.py b/examples/cfchannel/run_cfchannel_10nC_mlmg.py
@@ -58,7 +58,7 @@
 )
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/chicane/run_chicane.py b/examples/chicane/run_chicane.py
@@ -77,7 +77,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/chicane/run_chicane_csr.py b/examples/chicane/run_chicane_csr.py
@@ -79,7 +79,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/chicane/run_chicane_madx.py b/examples/chicane/run_chicane_madx.py
@@ -46,7 +46,7 @@
 sim.lattice.load_file("chicane.madx", nslice=25)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/compression/run_compression.py b/examples/compression/run_compression.py
@@ -56,7 +56,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/coupled_optics/run_coupled_optics.py b/examples/coupled_optics/run_coupled_optics.py
@@ -75,7 +75,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/cyclotron/run_cyclotron.py b/examples/cyclotron/run_cyclotron.py
@@ -62,7 +62,7 @@
 sim.periods = 150
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/distgen/run_gaussian_twiss.py b/examples/distgen/run_gaussian_twiss.py
@@ -67,7 +67,7 @@
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/distgen/run_kurth4d.py b/examples/distgen/run_kurth4d.py
@@ -58,7 +58,7 @@
 sim.lattice.extend(constf)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/distgen/run_kvdist_twiss.py b/examples/distgen/run_kvdist_twiss.py
@@ -67,7 +67,7 @@
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/distgen/run_semigaussian.py b/examples/distgen/run_semigaussian.py
@@ -65,7 +65,7 @@
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/dogleg/run_dogleg.py b/examples/dogleg/run_dogleg.py
@@ -71,7 +71,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/epac2004_benchmarks/run_bithermal.py b/examples/epac2004_benchmarks/run_bithermal.py
@@ -65,7 +65,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/epac2004_benchmarks/run_fodo_rf_SC.py b/examples/epac2004_benchmarks/run_fodo_rf_SC.py
@@ -197,7 +197,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/epac2004_benchmarks/run_thermal.py b/examples/epac2004_benchmarks/run_thermal.py
@@ -62,7 +62,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/expanding_beam/run_expanding_fft.py b/examples/expanding_beam/run_expanding_fft.py
@@ -58,7 +58,7 @@
 sim.lattice.extend([monitor, elements.Drift(name="d1", ds=6.0, nslice=40), monitor])
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/expanding_beam/run_expanding_mlmg.py b/examples/expanding_beam/run_expanding_mlmg.py
@@ -57,7 +57,7 @@
 sim.lattice.extend([monitor, elements.Drift(name="d1", ds=6.0, nslice=40), monitor])
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo/run_fodo.py b/examples/fodo/run_fodo.py
@@ -65,7 +65,7 @@
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo/run_fodo_madx.py b/examples/fodo/run_fodo_madx.py
@@ -47,7 +47,7 @@
 sim.lattice.load_file("fodo.madx", nslice=25)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo/run_fodo_twiss.py b/examples/fodo/run_fodo_twiss.py
@@ -67,7 +67,7 @@
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo_channel/run_fodo.py b/examples/fodo_channel/run_fodo.py
@@ -65,7 +65,7 @@
 sim.periods = 101
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo_chromatic/run_fodo_chr.py b/examples/fodo_chromatic/run_fodo_chr.py
@@ -65,7 +65,7 @@
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo_programmable/run_fodo_programmable.py b/examples/fodo_programmable/run_fodo_programmable.py
@@ -149,7 +149,7 @@ def my_ref_drift(pge, refpart):
 sim.lattice.extend(fodo)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo_rf/run_fodo_rf.py b/examples/fodo_rf/run_fodo_rf.py
@@ -64,7 +64,7 @@
 sim.lattice.append(monitor)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/fodo_tune/run_fodo_tune.py b/examples/fodo_tune/run_fodo_tune.py
@@ -64,7 +64,7 @@
 sim.periods = 100
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 del sim

diff --git a/examples/initialize_from_array/run_from_array.py b/examples/initialize_from_array/run_from_array.py
@@ -103,7 +103,7 @@
     ]
 )
 
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/iota_lattice/run_iotalattice.py b/examples/iota_lattice/run_iotalattice.py
@@ -120,7 +120,7 @@
 sim.periods = 5
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/iota_lattice/run_iotalattice_sdep.py b/examples/iota_lattice/run_iotalattice_sdep.py
@@ -216,7 +216,7 @@
 sim.periods = 5
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/iota_lens/run_iotalens.py b/examples/iota_lens/run_iotalens.py
@@ -63,7 +63,7 @@
 sim.lattice.extend(nllens_lattice)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/iota_lens/run_iotalens_sdep.py b/examples/iota_lens/run_iotalens_sdep.py
@@ -96,7 +96,7 @@
 sim.periods = 1
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/kicker/run_hvkicker_madx.py b/examples/kicker/run_hvkicker_madx.py
@@ -46,7 +46,7 @@
 sim.lattice.load_file("hvkicker.madx", nslice=1)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/kicker/run_kicker.py b/examples/kicker/run_kicker.py
@@ -54,7 +54,7 @@
 sim.lattice.extend(kicklattice)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/kicker/run_kicker_madx.py b/examples/kicker/run_kicker_madx.py
@@ -46,7 +46,7 @@
 sim.lattice.load_file("kicker.madx", nslice=1)
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()
diff --git a/examples/kurth/run_kurth_10nC_periodic.py b/examples/kurth/run_kurth_10nC_periodic.py
@@ -52,7 +52,7 @@
 sim.lattice.extend([monitor, drift1, constf1, drift1, monitor])
 
 # run simulation
-sim.evolve()
+sim.track_particles()
 
 # clean shutdown
 sim.finalize()