Handling improvements (#9)

* A variable to tell you what strings have been send to and from MAD-NG
* Allow debug to not just go to the stdout
* Change how the ctrl-c is handled. Previous way led to the process hanging.
* Update test names to be more typical
* Rename most variables to make it clearer
* Prepare version update
* Modernise workflows (#8) (#10)
* Version bumps
* Remove EOL python
* Change workflow to use editable install - May revert
* Update to use Pathlib and do check for binary first
* Update test-pymadng.yml to MAD 0.9.8
* Remove speed test (Useless - slowdown caused by history feature)
* Update python-publish.yml for next release

---------

Co-authored-by: jgray-19 <[email protected]>

Author: jgray-19

.github/workflows/python-publish.yml

@@ -37,8 +37,8 @@ jobs:
     - name: Get MAD Binaries
       run: |
         mkdir src/pymadng/bin 
-        curl http://madx.web.cern.ch/madx/releases/madng/madng-linux-latest -o src/pymadng/bin/mad_Linux
-        curl http://madx.web.cern.ch/madx/releases/madng/madng-macos-latest -o src/pymadng/bin/mad_Darwin
+        curl https://madx.web.cern.ch/madx/releases/madng/0.9/mad-linux-0.9.9 -o src/pymadng/bin/mad_Linux
+        curl https://madx.web.cern.ch/madx/releases/madng/0.9/mad-macos-0.9.9 -o src/pymadng/bin/mad_Darwin
         chmod +x src/pymadng/bin/mad_Linux src/pymadng/bin/mad_Darwin
     - name: Build package
       run: python -m build

.github/workflows/test-pymadng.yml

@@ -15,6 +15,9 @@ on:
 jobs:
   build:
     runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
     strategy:
       fail-fast: false
       matrix:
@@ -29,14 +32,14 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Get MAD Binaries
       run: |
-        mkdir src/pymadng/bin 
-        curl http://madx.web.cern.ch/madx/releases/madng/madng-linux-latest -o src/pymadng/bin/mad_Linux
-        curl http://madx.web.cern.ch/madx/releases/madng/madng-macos-latest -o src/pymadng/bin/mad_Darwin
-        chmod +x src/pymadng/bin/mad_Linux src/pymadng/bin/mad_Darwin
+        mkdir ./src/pymadng/bin 
+        curl https://madx.web.cern.ch/madx/releases/madng/0.9/mad-linux-0.9.8 -o ./src/pymadng/bin/mad_Linux
+        curl https://madx.web.cern.ch/madx/releases/madng/0.9/mad-macos-0.9.8 -o ./src/pymadng/bin/mad_Darwin
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install -e .[tfs]
     - name: Test with python
       run: |
+        chmod +x ./src/pymadng/bin/mad_Linux ./src/pymadng/bin/mad_Darwin
         python -m unittest tests/*

CHANGELOG.md

@@ -1,3 +1,11 @@
+0.5.0 (2024/10/30)
+
+Add `history` method to get the history of communication of strings to MAD-NG. \
+Rename a significant amount of the code to be more readable. \
+Allow debug mode to be set to a string, which will be the file that the debug information is written to. \
+Remove support for Python EOL, now only supporting Python 3.9 and above. \
+Change how ctrl-c is handled, now it will raise a KeyboardInterrupt error and delete the MAD process. \
+
 0.4.6 (2024/01/17)
 
 No change, releasing with MAD 0.9.8-1

examples/ex-benchmark-and-fork/ex-benchmark-and-fork.py

@@ -75,7 +75,7 @@
         # METHOD 2
         mad["circum", "lcell"] = 60, 20
         mad["deferred"] = mad.MAD.typeid.deferred
-        mad["v"] = mad.deferred(f = "lcell/math.sin(math.pi/4)/4", k = "1/v.f")
+        mad["v"] = mad.create_deferred_expression(f = "lcell/math.sin(math.pi/4)/4", k = "1/v.f")
 
         mad["qf"] = mad.quadrupole("knl:={0,  v.k}", l = 1)
         mad["qd"] = mad.quadrupole("knl:={0,  -v.k}", l = 1)

examples/ex-fodo/ex-fodos.py

@@ -17,7 +17,7 @@
     mad.load("MADX", "seq")
     mad.seq.beam = mad.beam()
     mad["mtbl", "mflw"] = mad.twiss(sequence=mad.seq, method=4, implicit=True, nslice=10, save="'atbody'")
-    cols = mad.py_strs_to_mad_strs(["name", "s", "beta11", "beta22", "mu1", "mu2", "alfa11", "alfa22"])
+    cols = mad.quote_strings(["name", "s", "beta11", "beta22", "mu1", "mu2", "alfa11", "alfa22"])
     mad.mtbl.write("'twiss_py.tfs'", cols)
     for x in mad.seq:
         print(x.name, x.kind)
@@ -30,7 +30,7 @@
     mad["circum", "lcell"] = 60, 20
 
     mad.load("math", "sin", "pi")
-    mad["v"] = mad.deferred(k="1/(lcell/sin(pi/4)/4)")
+    mad["v"] = mad.create_deferred_expression(k="1/(lcell/sin(pi/4)/4)")
 
     mad["qf"] = mad.quadrupole("knl:={0,  v.k}", l=1)
     mad["qd"] = mad.quadrupole("knl:={0, -v.k}", l=1)
@@ -44,7 +44,7 @@
         """, refer="'entry'", l=mad.circum,)
     mad.seq.beam = mad.beam()
     mad["mtbl", "mflw"] = mad.twiss(sequence=mad.seq, method=4, implicit=True, nslice=10, save="'atbody'")
-    cols = mad.py_strs_to_mad_strs(["name", "s", "beta11", "beta22", "mu1", "mu2", "alfa11", "alfa22"])
+    cols = mad.quote_strings(["name", "s", "beta11", "beta22", "mu1", "mu2", "alfa11", "alfa22"])
     mad.mtbl.write("'twiss_py.tfs'", cols)
 
     plt.plot(mad.mtbl.s, mad.mtbl["beta11"])

examples/ex-lhc-couplingLocal/lhc-couplingLocal.py

@@ -21,7 +21,7 @@
         "'invalid number of elements %d in LHCB1 (6694 expected)'", "#lhcb1")
 
     mad.lhcb1.beam = mad.beam(particle="'proton'", energy=mad.nrj)
-    mad.MADX_env_send("""
+    mad.evaluate_in_madx_environment("""
     ktqx1_r2 = -ktqx1_l2 ! remove the link between these 2 vars
     kqsx3_l2 = -0.0015
     kqsx3_r2 = +0.0015

examples/ex-ps-twiss/ps-twiss.py

@@ -18,21 +18,21 @@
     mad["srv", "mflw"] = mad.survey(sequence=mad.ps)
 
     mad.srv.write("'PS_survey_py.tfs'",
-        mad.py_strs_to_mad_strs(["name", "kind", "s", "l", "angle", "x", "y", "z", "theta"]),
+        mad.quote_strings(["name", "kind", "s", "l", "angle", "x", "y", "z", "theta"]),
         )
 
     mad["mtbl", "mflw"] = mad.twiss(sequence=mad.ps, method=6, nslice=3, chrom=True)
 
     mad.load("MAD.gphys", "melmcol")
     #Add element properties as columns
     mad.melmcol(mad.mtbl,
-        mad.py_strs_to_mad_strs(
+        mad.quote_strings(
             ["angle", "tilt", "k0l", "k1l", "k2l", "k3l", "k4l", "k5l", "k6l", "k0sl",
             "k1sl", "k2sl", "k3sl", "k4sl", "k5sl", "k6sl", "ksl", "hkick", "vkick" ]),
         )
 
     mad.mtbl.write("'PS_twiss_py.tfs'",
-        mad.py_strs_to_mad_strs(
+        mad.quote_strings(
             ["name", "kind", "s", "x", "px", "beta11", "alfa11", "beta22", "alfa22","dx",
             "dpx", "mu1", "mu2", "l", "angle", "k0l", "k1l", "k2l", "k3l", "hkick", "vkick"]
             )

pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 name = "pymadng"
 dynamic = ["version"]
 authors = [
-  { name="Joshua Gray", email="[email protected]" },
+  { name="Joshua Gray" },
 ]
 description = "A python interface to MAD-NG running as subprocess"
 readme = "README.md"

src/pymadng/__init__.py

@@ -1,7 +1,7 @@
 from .madp_object import MAD
 
 __title__ = "pymadng"
-__version__ = "0.4.6"
+__version__ = "0.5.0"
 
 __summary__ = "Python interface to MAD-NG running as subprocess"
 __uri__ = "https://github.com/MethodicalAcceleratorDesign/MADpy"