Skip to content

Commit 99b1c48

Browse files
authored
Skip 'Element' suffix for common elements (pals-project#28)
Skip the `Element` suffix for common elements such as drifts, quadrupoles, etc., and close pals-project#27.
1 parent 0bc4878 commit 99b1c48

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

examples/fodo.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,35 @@
77
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../src/")))
88

99
from pals_schema.MagneticMultipoleParameters import MagneticMultipoleParameters
10-
from pals_schema.DriftElement import DriftElement
11-
from pals_schema.QuadrupoleElement import QuadrupoleElement
10+
from pals_schema.Drift import Drift
11+
from pals_schema.Quadrupole import Quadrupole
1212
from pals_schema.BeamLine import BeamLine
1313

1414

1515
def main():
16-
drift1 = DriftElement(
16+
drift1 = Drift(
1717
name="drift1",
1818
length=0.25,
1919
)
20-
quad1 = QuadrupoleElement(
20+
quad1 = Quadrupole(
2121
name="quad1",
2222
length=1.0,
2323
MagneticMultipoleP=MagneticMultipoleParameters(
2424
Bn1=1.0,
2525
),
2626
)
27-
drift2 = DriftElement(
27+
drift2 = Drift(
2828
name="drift2",
2929
length=0.5,
3030
)
31-
quad2 = QuadrupoleElement(
31+
quad2 = Quadrupole(
3232
name="quad2",
3333
length=1.0,
3434
MagneticMultipoleP=MagneticMultipoleParameters(
3535
Bn1=-1.0,
3636
),
3737
)
38-
drift3 = DriftElement(
38+
drift3 = Drift(
3939
name="drift3",
4040
length=0.5,
4141
)

src/pals_schema/BeamLine.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
from pals_schema.BaseElement import BaseElement
55
from pals_schema.ThickElement import ThickElement
6-
from pals_schema.DriftElement import DriftElement
7-
from pals_schema.QuadrupoleElement import QuadrupoleElement
6+
from pals_schema.Drift import Drift
7+
from pals_schema.Quadrupole import Quadrupole
88

99

1010
class BeamLine(BaseElement):
@@ -21,8 +21,8 @@ class BeamLine(BaseElement):
2121
Union[
2222
BaseElement,
2323
ThickElement,
24-
DriftElement,
25-
QuadrupoleElement,
24+
Drift,
25+
Quadrupole,
2626
"BeamLine",
2727
],
2828
Field(discriminator="kind"),

src/pals_schema/DriftElement.py renamed to src/pals_schema/Drift.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from .ThickElement import ThickElement
44

55

6-
class DriftElement(ThickElement):
6+
class Drift(ThickElement):
77
"""A field free region"""
88

99
# Discriminator field

src/pals_schema/QuadrupoleElement.py renamed to src/pals_schema/Quadrupole.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from .MagneticMultipoleParameters import MagneticMultipoleParameters
55

66

7-
class QuadrupoleElement(ThickElement):
7+
class Quadrupole(ThickElement):
88
"""A quadrupole element"""
99

1010
# Discriminator field

tests/test_schema.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
from pals_schema.MagneticMultipoleParameters import MagneticMultipoleParameters
1212
from pals_schema.BaseElement import BaseElement
1313
from pals_schema.ThickElement import ThickElement
14-
from pals_schema.DriftElement import DriftElement
15-
from pals_schema.QuadrupoleElement import QuadrupoleElement
14+
from pals_schema.Drift import Drift
15+
from pals_schema.Quadrupole import Quadrupole
1616
from pals_schema.BeamLine import BeamLine
1717

1818

@@ -45,11 +45,11 @@ def test_ThickElement():
4545
assert not passed
4646

4747

48-
def test_DriftElement():
48+
def test_Drift():
4949
# Create one drift element with custom name and length
5050
element_name = "drift_element"
5151
element_length = 1.0
52-
element = DriftElement(
52+
element = Drift(
5353
name=element_name,
5454
length=element_length,
5555
)
@@ -67,7 +67,7 @@ def test_DriftElement():
6767
assert not passed
6868

6969

70-
def test_QuadrupoleElement():
70+
def test_Quadrupole():
7171
# Create one drift element with custom name and length
7272
element_name = "quadrupole_element"
7373
element_length = 1.0
@@ -85,7 +85,7 @@ def test_QuadrupoleElement():
8585
Bs2=element_magnetic_multipole_Bs2,
8686
tilt2=element_magnetic_multipole_tilt2,
8787
)
88-
element = QuadrupoleElement(
88+
element = Quadrupole(
8989
name=element_name,
9090
length=element_length,
9191
MagneticMultipoleP=element_magnetic_multipole,
@@ -113,7 +113,7 @@ def test_BeamLine():
113113
line1.line.extend([element2])
114114
assert line1.line == [element1, element2]
115115
# Create second line with one drift element
116-
element3 = DriftElement(name="element3", length=3.0)
116+
element3 = Drift(name="element3", length=3.0)
117117
line2 = BeamLine(name="line2", line=[element3])
118118
# Extend first line with second line
119119
line1.line.extend(line2.line)

0 commit comments

Comments
 (0)