Merge pull request #167 from desy-ml/rename-converters

Rename converter modules

Author: jank324

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Update versions in pre-commit config (see #148) (@jank324)
 - Split `accelerator` and `beam` into separate submodules (see #158) (@jank324)
 - Update reference from arXiv preprint to PRAB publication (see #166) (@jank324)
+- Rename converter modules to the respective name of the accelerator code (see #167) (@jank324)
 
 ## [v0.6.3](https://github.com/desy-ml/cheetah/releases/tag/v0.6.3) (2024-03-28)
 

cheetah/accelerator/segment.py

@@ -9,7 +9,7 @@
 from scipy.constants import physical_constants
 from torch import Size, nn
 
-from cheetah.converters.dontbmad import convert_bmad_lattice
+from cheetah.converters.bmad import convert_bmad_lattice
 from cheetah.converters.nxtables import read_nx_tables
 from cheetah.latticejson import load_cheetah_model, save_cheetah_model
 from cheetah.particles import Beam, ParticleBeam
@@ -273,7 +273,7 @@ def from_ocelot(
             Cheetah or converted with potentially unexpected behavior.
         :return: Cheetah segment closely resembling the Ocelot cell.
         """
-        from cheetah.converters.nocelot import ocelot2cheetah
+        from cheetah.converters.ocelot import ocelot2cheetah
 
         converted = [
             ocelot2cheetah(element, warnings=warnings, device=device, dtype=dtype)

cheetah/converters/__init__.py

@@ -1,2 +1,2 @@
 # flake8: noqa
-from cheetah.converters import astralavista, dontbmad, nocelot, nxtables
+from cheetah.converters import astra, bmad, nxtables, ocelot

cheetah/converters/astralavista.py cheetah/converters/astra.py

@@ -256,7 +256,7 @@ def from_ocelot(cls, parray, device=None, dtype=torch.float32) -> "ParameterBeam
     @classmethod
     def from_astra(cls, path: str, device=None, dtype=torch.float32) -> "ParameterBeam":
         """Load an Astra particle distribution as a Cheetah Beam."""
-        from cheetah.converters.astralavista import from_astrabeam
+        from cheetah.converters.astra import from_astrabeam
 
         particles, energy, particle_charges = from_astrabeam(path)
         mu = torch.ones(7)

cheetah/converters/dontbmad.py cheetah/converters/bmad.py

@@ -571,7 +571,7 @@ def from_ocelot(cls, parray, device=None, dtype=torch.float32) -> "ParticleBeam"
     @classmethod
     def from_astra(cls, path: str, device=None, dtype=torch.float32) -> "ParticleBeam":
         """Load an Astra particle distribution as a Cheetah Beam."""
-        from cheetah.converters.astralavista import from_astrabeam
+        from cheetah.converters.astra import from_astrabeam
 
         particles, energy, particle_charges = from_astrabeam(path)
         particles_7d = torch.ones((particles.shape[0], 7))

cheetah/converters/nocelot.py cheetah/converters/ocelot.py

@@ -0,0 +1,20 @@
+.. Documents converters
+
+Converters
+==========
+
+.. automodule:: converters.astra
+    :members:
+    :undoc-members:
+
+.. automodule:: converters.bmad
+    :members:
+    :undoc-members:
+
+.. automodule:: converters.nxtables
+    :members:
+    :undoc-members:
+
+.. automodule:: converters.ocelot
+    :members:
+    :undoc-members:

cheetah/particles/parameter_beam.py

@@ -48,11 +48,9 @@ For more advanced usage, please refer to the in-depth documentation.
     :caption: Documentation
 
     accelerator
-    astralavista
-    dontbmad
+    converters
     error
     latticejson
-    nocelot
     particles
     track_methods
     utils

cheetah/particles/particle_beam.py

@@ -256,7 +256,7 @@ def test_ares_ea():
     Test that the tracking results through a Experimental Area (EA) lattice of the ARES
     accelerator at DESY match those using Ocelot.
     """
-    cell = cheetah.converters.nocelot.subcell_of_ocelot(
+    cell = cheetah.converters.ocelot.subcell_of_ocelot(
         ares.cell, "AREASOLA1", "AREABSCR1"
     )
     ares.areamqzm1.k1 = 5.0

docs/astralavista.rst

@@ -10,7 +10,7 @@
 # TODO: Test that Cheeath tracks faster than Ocelot
 def test_tracking_speed():
     """Really only tests that Cheetah isn't super slow."""
-    cell = cheetah.converters.nocelot.subcell_of_ocelot(
+    cell = cheetah.converters.ocelot.subcell_of_ocelot(
         ares.cell, "AREASOLA1", "AREABSCR1"
     )
     segment = cheetah.Segment.from_ocelot(cell)