Merge pull request #17 from xsuite/release/v0.3.0

Release 0.3.0

Author: freddieknets

examples/executables/xboinc_0.1-x86_64-pc-linux-gnu

@@ -1,6 +1,6 @@
 # copyright ############################### #
 # This file is part of the Xboinc Package.  #
-# Copyright (c) CERN, 2023.                 #
+# Copyright (c) CERN, 2024.                 #
 ########################################### #
 
 import subprocess
@@ -16,35 +16,37 @@
 # Create simulation input
 num_turns = 20
 num_particles = 5000
-line = xt.Line.from_json(xc._pkg_root.parent / 'examples' / 'machines' / f'lhc_run3_b1.json')
-coll_manager = xc.CollimatorManager.from_yaml(xc._pkg_root.parent / 'examples' / 'colldb' / f'lhc_run3.yaml', line=line, beam=1)
+line = xt.Line.from_json(xb._pkg_root.parent / 'tests' / 'data' / 'lhc_2024_30cm_b1.json')
+coll_manager = xc.CollimatorManager.from_yaml(xb._pkg_root.parent / 'tests' / 'data' / 'lhc_run3.yaml', line=line, beam=1)
 coll_manager.install_everest_collimators()
 coll_manager.build_tracker()
 coll_manager.set_openings()
 part = coll_manager.generate_pencil_on_collimator('tcp.c6l7.b1', num_particles=num_particles)
 coll_manager.enable_scattering()
-xb.SimConfig.build(line=line, particles=part, num_turns=num_turns, filename='xboinc_input.bin', checkpoint_every=5)
+input = xb.XbInput(line=line, particles=part, num_turns=num_turns, checkpoint_every=5)
+input.to_binary('xboinc_input.bin')
 
 
 # Run xboinc
 cmd    = subprocess.run(['uname', '-m'], stdout=subprocess.PIPE)
 arch   = cmd.stdout.decode('UTF-8').strip().lower()
 cmd    = subprocess.run(['uname', '-s'], stdout=subprocess.PIPE)
 thisos = cmd.stdout.decode('UTF-8').strip().lower()
-exec_files = list(Path.cwd().glob(f'xboinc_{xb.app_version}-*'))
-exec_files = [f for f in exec_files if arch in str(f) and thisos in str(f)]
+exec_files  = list((Path.cwd().parent / 'executables').glob(f'xboinc_{xb.app_version}-*'))
+exec_files += list((Path.cwd().parent / 'executables').glob(f'xboinc_test_{xb.app_version}-*'))
+exec_files  = [f for f in exec_files if arch in str(f) and thisos in str(f)]
 if len(exec_files)==0 or not exec_files[0].exists():
     raise ValueError("No executable found")
 exec_file = exec_files[0]
-cmd = subprocess.run(exec_file)
+cmd = subprocess.run([exec_file, '--verbose', '1'])
 if cmd.returncode != 0:
     raise RuntimeError(f"Tracking failed.")
 
 
 # Read output
-filename = 'sim_state_out.bin'
-sim_state = xb.SimState.from_binary(filename)
-part = sim_state.particles
-_ = coll_manager.lossmap(part, file=Path(path_out,f'lossmap_B1H.json'))
-summary = coll_manager.summary(part, file=Path(path_out,f'coll_summary_B1H.out'))
+filename = 'xboinc_state_out.bin'
+xb_state = xb.XbState.from_binary(filename)
+part = xb_state.particles
+_ = coll_manager.lossmap(part, file=Path('lossmap_B1H.json'))
+summary = coll_manager.summary(part, file=Path('coll_summary_B1H.out'))
 print(summary)

examples/executables/xboinc_test_0.1-x86_64-pc-linux-gnu

@@ -1,6 +1,6 @@
 # copyright ############################### #
 # This file is part of the Xboinc Package.  #
-# Copyright (c) CERN, 2023.                 #
+# Copyright (c) CERN, 2024.                 #
 ########################################### #
 
 import subprocess
@@ -17,32 +17,33 @@
 line = xt.Line(elements=[
     xt.Drift(length=1.0), xt.Multipole(knl=[1e-6]), xt.Drift(length=1.0)])
 particles = xp.Particles(mass0=xp.PROTON_MASS_EV, p0c=7e12, x=[1e-6,2e-6,3e-6])
-xb.SimConfig.build(line=line, particles=particles, num_turns=num_turns,
-                    filename='xboinc_input.bin')
+input = xb.XbInput(line=line, particles=particles, num_turns=num_turns)
+input.to_binary('xboinc_input.bin')
 
 
 # Run xboinc
 cmd    = subprocess.run(['uname', '-m'], stdout=subprocess.PIPE)
 arch   = cmd.stdout.decode('UTF-8').strip().lower()
 cmd    = subprocess.run(['uname', '-s'], stdout=subprocess.PIPE)
 thisos = cmd.stdout.decode('UTF-8').strip().lower()
-exec_files = list(Path.cwd().glob(f'xboinc_{xb.app_version}-*'))
-exec_files = [f for f in exec_files if arch in str(f) and thisos in str(f)]
+exec_files  = list((Path.cwd().parent / 'executables').glob(f'xboinc_{xb.app_version}-*'))
+exec_files += list((Path.cwd().parent / 'executables').glob(f'xboinc_test_{xb.app_version}-*'))
+exec_files  = [f for f in exec_files if arch in str(f) and thisos in str(f)]
 if len(exec_files)==0 or not exec_files[0].exists():
     raise ValueError("No executable found")
 exec_file = exec_files[0]
-cmd = subprocess.run(exec_file)
+cmd = subprocess.run([exec_file, '--verbose', '1'])
 if cmd.returncode != 0:
     raise RuntimeError(f"Tracking failed.")
 
 
 # Read output
-filename = 'sim_state_out.bin'
-sim_state = xb.SimState.from_binary(filename)
-particles = sim_state.particles
+filename = 'xboinc_state_out.bin'
+xb_state = xb.XbState.from_binary(filename)
+particles = xb_state.particles
 
 assert np.all(particles.s == 0)
 assert np.all(particles.at_turn == num_turns)
-assert sim_state.i_turn == num_turns
+assert xb_state.i_turn == num_turns
 
 print('All checks passed!')

examples/running/lossmap.py renamed to examples/low_level_api/lossmap.py

@@ -6,10 +6,10 @@
 import xtrack as xt
 import xboinc as xb
 
-line = xt.Line.from_json('../tests/data/sequence_lhc_run3_b1.json')
+line = xt.Line.from_json(xb._pkg_root.parent / 'tests' / 'data' / 'lhc_2024_30cm_b1.json')
 line.build_tracker()
 file_in  = Path('xboinc_input.bin')
-file_out = Path('sim_state_out.bin')
+file_out = Path('xboinc_state_out.bin')
 
 num_part = 200
 num_turns = 50
@@ -19,17 +19,27 @@
                             y_norm=np.random.normal(0, 10, num_part),
                             nemitt_x=3.5e-6, nemitt_y=3.5e-6)
 
-xb.SimConfig.build(filename=file_in, num_turns=num_turns, line=line,
-                   particles=part, checkpoint_every=checkpoint_every)
+input = xb.XbInput(num_turns=num_turns, line=line, particles=part, checkpoint_every=checkpoint_every)
+input.to_binary(file_in)
 
 print("")
+cmd    = subprocess.run(['uname', '-m'], stdout=subprocess.PIPE)
+arch   = cmd.stdout.decode('UTF-8').strip().lower()
+cmd    = subprocess.run(['uname', '-s'], stdout=subprocess.PIPE)
+thisos = cmd.stdout.decode('UTF-8').strip().lower()
+exec_files  = list((Path.cwd().parent / 'executables').glob(f'xboinc_{xb.app_version}-*'))
+exec_files += list((Path.cwd().parent / 'executables').glob(f'xboinc_test_{xb.app_version}-*'))
+exec_files  = [f for f in exec_files if arch in str(f) and thisos in str(f)]
+if len(exec_files)==0 or not exec_files[0].exists():
+    raise ValueError("No executable found")
+exec_file = exec_files[0]
 now = time.time()
-cmd = subprocess.run(['running/xboinc_0.1-x86_64-pc-linux-gnu'])
+cmd = subprocess.run([exec_file, '--verbose', '1'])
 print(f"Tracking with executable: done in {time.time()-now:.1f}s")
 line.track(part, num_turns=num_turns, time=True)
 print(f"Tracking from within python: done in {line.time_last_track:.1f}s.")
 
-exec_part = xb.SimState.from_binary(file_out).particles
+exec_part = xb.XbState.from_binary(file_out).particles
 assert np.all(part.state == exec_part.state)
 assert np.allclose(part.x, exec_part.x, rtol=1e-10)
 assert np.allclose(part.px, exec_part.px, rtol=1e-10)

examples/running/simple_line.py renamed to examples/low_level_api/simple_line.py

@@ -1,6 +1,6 @@
 # copyright ############################### #
 # This file is part of the Xboinc Package.  #
-# Copyright (c) CERN, 2023.                 #
+# Copyright (c) CERN, 2024.                 #
 ########################################### #
 
 import xboinc as xb

examples/timing.py renamed to examples/low_level_api/timing.py

@@ -1,7 +1,12 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2024.                 #
+########################################### #
+
 import xboinc as xb
 
 list_of_succeeded_jobs = []
-user='ddicroce'
+user='sixtadm'
 study_name='example_study'
 for new_particles, jobinfo in xb.RetrieveJobs(user=user, study_name=study_name):
     print(jobinfo)