simba-accelerator 0.5.0__tar.gz → 0.6.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/.gitignore +11 -1
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/PKG-INFO +4 -3
- simba_accelerator-0.6.0/docs/source/Framework_elements.rst +10 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/SimCodes.rst +2 -4
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/conf.py +30 -7
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/getting-started.rst +0 -1
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/index.rst +8 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/loading-a-lattice.rst +42 -1
- simba_accelerator-0.6.0/docs/source/ring-studies.rst +961 -0
- simba_accelerator-0.5.0/docs/source/simba.Codes.MAD8.rst → simba_accelerator-0.6.0/docs/source/simba.Codes.Bmad.rst +4 -4
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.Cheetah.rst +0 -8
- simba_accelerator-0.6.0/docs/source/simba.Codes.Genesis.rst +21 -0
- simba_accelerator-0.6.0/docs/source/simba.Codes.MADX.rst +21 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.Ocelot.rst +3 -3
- simba_accelerator-0.6.0/docs/source/simba.Codes.Wake_T.rst +21 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.Xsuite.rst +0 -8
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.rst +4 -1
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Modules.Beams.rst +16 -8
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Modules.Matrices.rst +0 -8
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Modules.Twiss.rst +24 -0
- simba_accelerator-0.6.0/docs/source/simba.Modules.plotting.rst +29 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Modules.rst +8 -42
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.rst +9 -16
- simba_accelerator-0.6.0/examples/ring_studies/da_fma.png +0 -0
- simba_accelerator-0.6.0/examples/ring_studies/da_fma.py +141 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/pyproject.toml +3 -2
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/requirements.txt +2 -2
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/ASTRA/ASTRA.py +131 -147
- simba_accelerator-0.6.0/simba/Codes/Bmad/Bmad.py +837 -0
- simba_accelerator-0.6.0/simba/Codes/Bmad/__init__.py +1 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/CSRTrack/CSRTrack.py +30 -73
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Cheetah/Cheetah.py +47 -99
- simba_accelerator-0.6.0/simba/Codes/Elegant/Elegant.py +1693 -0
- simba_accelerator-0.6.0/simba/Codes/Executables.py +400 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/GPT/GPT.py +90 -228
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/Generators.py +78 -297
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/astra.py +6 -27
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/gpt.py +52 -131
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/opal.py +46 -114
- simba_accelerator-0.6.0/simba/Codes/Genesis/Genesis.py +1367 -0
- simba_accelerator-0.6.0/simba/Codes/MADX/MADX.py +2077 -0
- simba_accelerator-0.6.0/simba/Codes/MADX/__init__.py +1 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/MADX/madx_defaults.yaml +1 -1
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/OPAL/OPAL.py +109 -146
- simba_accelerator-0.6.0/simba/Codes/Ocelot/Ocelot.py +1126 -0
- simba_accelerator-0.6.0/simba/Codes/Ocelot/bendmaps.py +74 -0
- simba_accelerator-0.6.0/simba/Codes/Ocelot/cavitymaps.py +150 -0
- simba_accelerator-0.6.0/simba/Codes/Ocelot/fixedreference.py +64 -0
- simba_accelerator-0.6.0/simba/Codes/Ocelot/latticefile.py +48 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Ocelot/mbi.py +86 -224
- simba_accelerator-0.6.0/simba/Codes/Ocelot/navigator.py +135 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Ocelot/ocelot_defaults.yaml +0 -1
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Ocelot/savebeamopenpmd.py +9 -4
- simba_accelerator-0.6.0/simba/Codes/Wake_T/Wake_T.py +115 -0
- simba_accelerator-0.6.0/simba/Codes/Xsuite/Xsuite.py +1112 -0
- simba_accelerator-0.6.0/simba/Codes/__init__.py +1 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Executables.yaml +5 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Framework.py +467 -598
- simba_accelerator-0.6.0/simba/FrameworkHelperFunctions.py +240 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Framework_Settings.py +6 -4
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Framework_lattices.py +1 -1
- simba_accelerator-0.6.0/simba/Framework_objects.py +3757 -0
- simba_accelerator-0.6.0/simba/Modules/Beams/Particles/__init__.py +707 -0
- simba_accelerator-0.6.0/simba/Modules/Beams/Particles/centroids.py +183 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/Particles/emittance.py +44 -200
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/Particles/kde.py +1 -6
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/Particles/minimumVolumeEllipse.py +12 -14
- simba_accelerator-0.6.0/simba/Modules/Beams/Particles/sigmas.py +134 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/Particles/slice.py +93 -423
- simba_accelerator-0.6.0/simba/Modules/Beams/Particles/twiss.py +280 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/__init__.py +181 -359
- simba_accelerator-0.6.0/simba/Modules/Beams/astra.py +190 -0
- simba_accelerator-0.6.0/simba/Modules/Beams/cheetah.py +84 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/gdf.py +5 -11
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/genesis.py +24 -21
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/hdf5.py +14 -27
- simba_accelerator-0.6.0/simba/Modules/Beams/mad8.py +31 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/madx.py +21 -49
- simba_accelerator-0.6.0/simba/Modules/Beams/ocelot.py +86 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/opal.py +14 -49
- simba_accelerator-0.6.0/simba/Modules/Beams/openpmd.py +171 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/plot.py +14 -67
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/sdds.py +25 -63
- simba_accelerator-0.6.0/simba/Modules/Beams/wake_t.py +52 -0
- simba_accelerator-0.6.0/simba/Modules/Beams/xsuite.py +174 -0
- simba_accelerator-0.6.0/simba/Modules/DeviceProgram.py +319 -0
- simba_accelerator-0.6.0/simba/Modules/EnergyRamp.py +396 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/MathParser.py +16 -10
- simba_accelerator-0.6.0/simba/Modules/Matrices/__init__.py +485 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Matrices/elegant.py +2 -5
- simba_accelerator-0.6.0/simba/Modules/SDDSFile.py +13 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Twiss/__init__.py +227 -301
- simba_accelerator-0.6.0/simba/Modules/Twiss/astra.py +124 -0
- simba_accelerator-0.6.0/simba/Modules/Twiss/bmad.py +110 -0
- simba_accelerator-0.6.0/simba/Modules/Twiss/cheetah.py +82 -0
- simba_accelerator-0.6.0/simba/Modules/Twiss/elegant.py +139 -0
- simba_accelerator-0.6.0/simba/Modules/Twiss/genesis.py +76 -0
- simba_accelerator-0.6.0/simba/Modules/Twiss/gpt.py +102 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Twiss/hdf5.py +27 -6
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Twiss/madx.py +16 -20
- simba_accelerator-0.6.0/simba/Modules/Twiss/ocelot.py +177 -0
- simba_accelerator-0.6.0/simba/Modules/Twiss/opal.py +108 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Twiss/plot.py +26 -23
- simba_accelerator-0.6.0/simba/Modules/Twiss/xsuite.py +76 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Wavefronts/__init__.py +13 -42
- simba_accelerator-0.6.0/simba/Modules/__init__.py +9 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/gdf_beam.py +6 -11
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/plotting/plotting.py +36 -77
- simba_accelerator-0.6.0/simba/Modules/plotting/ring.py +225 -0
- simba_accelerator-0.6.0/simba/Modules/rf_focusing.py +159 -0
- simba_accelerator-0.6.0/simba/Modules/units.py +21 -0
- simba_accelerator-0.6.0/simba/exceptions.py +490 -0
- simba_accelerator-0.6.0/simba/yaml_checker.py +34 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba_accelerator.egg-info/PKG-INFO +4 -3
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba_accelerator.egg-info/SOURCES.txt +72 -46
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba_accelerator.egg-info/requires.txt +3 -2
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba_accelerator.egg-info/scm_file_list.json +72 -55
- simba_accelerator-0.6.0/simba_accelerator.egg-info/scm_version.json +8 -0
- simba_accelerator-0.6.0/tests/test_ocelot_tw1.py +54 -0
- simba_accelerator-0.6.0/tests/test_tw1_cavity.py +175 -0
- simba_accelerator-0.6.0/unit_tests/conftest.py +10 -0
- simba_accelerator-0.6.0/unit_tests/helpers.py +163 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_beam.py +94 -0
- simba_accelerator-0.6.0/unit_tests/test_bmad_bugs.py +20 -0
- simba_accelerator-0.6.0/unit_tests/test_bmad_turn_handback.py +312 -0
- simba_accelerator-0.6.0/unit_tests/test_bpm_has_no_beam_file.py +35 -0
- simba_accelerator-0.6.0/unit_tests/test_chicane_group.py +88 -0
- simba_accelerator-0.6.0/unit_tests/test_closed_orbit.py +145 -0
- simba_accelerator-0.6.0/unit_tests/test_collective_flags.py +116 -0
- simba_accelerator-0.6.0/unit_tests/test_cross_code_ring.py +427 -0
- simba_accelerator-0.6.0/unit_tests/test_csrtrack_bugs.py +16 -0
- simba_accelerator-0.6.0/unit_tests/test_device_programs.py +984 -0
- simba_accelerator-0.6.0/unit_tests/test_dynamic_aperture.py +496 -0
- simba_accelerator-0.6.0/unit_tests/test_energy_program.py +62 -0
- simba_accelerator-0.6.0/unit_tests/test_energy_ramp.py +415 -0
- simba_accelerator-0.6.0/unit_tests/test_exceptions.py +92 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_executables.py +30 -6
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_framework.py +118 -82
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_framework_lattice.py +28 -2
- simba_accelerator-0.6.0/unit_tests/test_framework_objects.py +100 -0
- simba_accelerator-0.6.0/unit_tests/test_frequency_map.py +195 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_generator.py +72 -36
- simba_accelerator-0.6.0/unit_tests/test_genesis_bugs.py +34 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_jfel_code_comparison.py +16 -16
- simba_accelerator-0.6.0/unit_tests/test_madx_native_turns.py +297 -0
- simba_accelerator-0.6.0/unit_tests/test_ocelot_bugs.py +11 -0
- simba_accelerator-0.6.0/unit_tests/test_ocelot_cavity_maps.py +80 -0
- simba_accelerator-0.6.0/unit_tests/test_ocelot_lattice_file.py +56 -0
- simba_accelerator-0.6.0/unit_tests/test_ocelot_navigator.py +128 -0
- simba_accelerator-0.6.0/unit_tests/test_one_turn_map.py +158 -0
- simba_accelerator-0.6.0/unit_tests/test_opal_bugs.py +7 -0
- simba_accelerator-0.6.0/unit_tests/test_otm_conventions.py +307 -0
- simba_accelerator-0.6.0/unit_tests/test_output_collisions.py +184 -0
- simba_accelerator-0.6.0/unit_tests/test_path_arc_lengths.py +168 -0
- simba_accelerator-0.6.0/unit_tests/test_periodic.py +100 -0
- simba_accelerator-0.6.0/unit_tests/test_plotting.py +37 -0
- simba_accelerator-0.6.0/unit_tests/test_radiation.py +215 -0
- simba_accelerator-0.6.0/unit_tests/test_rf_modes.py +391 -0
- simba_accelerator-0.6.0/unit_tests/test_ring_backend_guards.py +158 -0
- simba_accelerator-0.6.0/unit_tests/test_ring_outputs.py +840 -0
- simba_accelerator-0.6.0/unit_tests/test_ring_parameters.py +281 -0
- simba_accelerator-0.6.0/unit_tests/test_ring_plots.py +120 -0
- simba_accelerator-0.6.0/unit_tests/test_ring_reference_energy.py +379 -0
- simba_accelerator-0.6.0/unit_tests/test_sdds_file.py +33 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/unit_tests/test_simcodes_tracking.py +8 -11
- simba_accelerator-0.6.0/unit_tests/test_single_particle.py +132 -0
- simba_accelerator-0.6.0/unit_tests/test_solenoid_and_alignment.py +178 -0
- simba_accelerator-0.6.0/unit_tests/test_summary_scaling.py +71 -0
- simba_accelerator-0.6.0/unit_tests/test_superperiods.py +540 -0
- simba_accelerator-0.6.0/unit_tests/test_turn_axis.py +328 -0
- simba_accelerator-0.6.0/unit_tests/test_turn_count.py +310 -0
- simba_accelerator-0.6.0/unit_tests/test_twiss_readers.py +76 -0
- simba_accelerator-0.6.0/unit_tests/test_units.py +47 -0
- simba_accelerator-0.6.0/unit_tests/test_write_turns.py +71 -0
- simba_accelerator-0.6.0/unit_tests/test_xsuite_bugs.py +17 -0
- simba_accelerator-0.6.0/unit_tests/test_xsuite_space_charge.py +296 -0
- simba_accelerator-0.5.0/.coverage +0 -0
- simba_accelerator-0.5.0/docs/2.0 +0 -5
- simba_accelerator-0.5.0/docs/source/modules.rst +0 -7
- simba_accelerator-0.5.0/docs/source/simba.Framework_objects.rst +0 -7
- simba_accelerator-0.5.0/docs/source/simba.Modules.Fields.rst +0 -61
- simba_accelerator-0.5.0/docs/source/simba.Modules.optimisation.rst +0 -45
- simba_accelerator-0.5.0/docs/source/simba.Modules.plotting.rst +0 -45
- simba_accelerator-0.5.0/simba/Codes/Elegant/Elegant.py +0 -1251
- simba_accelerator-0.5.0/simba/Codes/Elegant/elements_Elegant.yaml +0 -2390
- simba_accelerator-0.5.0/simba/Codes/Executables.py +0 -606
- simba_accelerator-0.5.0/simba/Codes/Genesis/Genesis.py +0 -1621
- simba_accelerator-0.5.0/simba/Codes/MADX/MADX.py +0 -1329
- simba_accelerator-0.5.0/simba/Codes/Ocelot/Ocelot.py +0 -561
- simba_accelerator-0.5.0/simba/Codes/Wake_T/Wake_T.py +0 -159
- simba_accelerator-0.5.0/simba/Codes/Xsuite/Xsuite.py +0 -375
- simba_accelerator-0.5.0/simba/Codes/__init__.py +0 -6
- simba_accelerator-0.5.0/simba/Codes/type_conversion_rules.yaml +0 -99
- simba_accelerator-0.5.0/simba/FrameworkHelperFunctions.py +0 -410
- simba_accelerator-0.5.0/simba/Framework_objects.py +0 -2733
- simba_accelerator-0.5.0/simba/Modules/Beams/Particles/__init__.py +0 -1101
- simba_accelerator-0.5.0/simba/Modules/Beams/Particles/centroids.py +0 -377
- simba_accelerator-0.5.0/simba/Modules/Beams/Particles/sigmas.py +0 -265
- simba_accelerator-0.5.0/simba/Modules/Beams/Particles/twiss.py +0 -530
- simba_accelerator-0.5.0/simba/Modules/Beams/astra.py +0 -306
- simba_accelerator-0.5.0/simba/Modules/Beams/cheetah.py +0 -101
- simba_accelerator-0.5.0/simba/Modules/Beams/mad8.py +0 -133
- simba_accelerator-0.5.0/simba/Modules/Beams/ocelot.py +0 -114
- simba_accelerator-0.5.0/simba/Modules/Beams/openpmd.py +0 -99
- simba_accelerator-0.5.0/simba/Modules/Beams/vsim.py +0 -58
- simba_accelerator-0.5.0/simba/Modules/Beams/wake_t.py +0 -99
- simba_accelerator-0.5.0/simba/Modules/Beams/xsuite.py +0 -153
- simba_accelerator-0.5.0/simba/Modules/Fields/FieldParameter.py +0 -21
- simba_accelerator-0.5.0/simba/Modules/Fields/__init__.py +0 -486
- simba_accelerator-0.5.0/simba/Modules/Fields/astra.py +0 -355
- simba_accelerator-0.5.0/simba/Modules/Fields/gdf.py +0 -293
- simba_accelerator-0.5.0/simba/Modules/Fields/hdf5.py +0 -169
- simba_accelerator-0.5.0/simba/Modules/Fields/opal.py +0 -255
- simba_accelerator-0.5.0/simba/Modules/Fields/sdds.py +0 -163
- simba_accelerator-0.5.0/simba/Modules/Matrices/__init__.py +0 -169
- simba_accelerator-0.5.0/simba/Modules/Matrices/hdf5.py +0 -36
- simba_accelerator-0.5.0/simba/Modules/SDDSFile.py +0 -504
- simba_accelerator-0.5.0/simba/Modules/Twiss/MADx.py +0 -102
- simba_accelerator-0.5.0/simba/Modules/Twiss/astra.py +0 -145
- simba_accelerator-0.5.0/simba/Modules/Twiss/cheetah.py +0 -105
- simba_accelerator-0.5.0/simba/Modules/Twiss/elegant.py +0 -178
- simba_accelerator-0.5.0/simba/Modules/Twiss/genesis.py +0 -110
- simba_accelerator-0.5.0/simba/Modules/Twiss/gpt.py +0 -153
- simba_accelerator-0.5.0/simba/Modules/Twiss/ocelot.py +0 -213
- simba_accelerator-0.5.0/simba/Modules/Twiss/opal.py +0 -108
- simba_accelerator-0.5.0/simba/Modules/Twiss/xsuite.py +0 -104
- simba_accelerator-0.5.0/simba/Modules/__init__.py +0 -26
- simba_accelerator-0.5.0/simba/Modules/id_number.py +0 -31
- simba_accelerator-0.5.0/simba/Modules/id_number_server.py +0 -45
- simba_accelerator-0.5.0/simba/Modules/merge_two_dicts.py +0 -48
- simba_accelerator-0.5.0/simba/Modules/optimisation/__init__.py +0 -1
- simba_accelerator-0.5.0/simba/Modules/optimisation/constraints.py +0 -79
- simba_accelerator-0.5.0/simba/Modules/optimisation/nelder_mead.py +0 -145
- simba_accelerator-0.5.0/simba/Modules/optimisation/optimiser.py +0 -310
- simba_accelerator-0.5.0/simba/Modules/optimisation/xopt.py +0 -136
- simba_accelerator-0.5.0/simba/Modules/plotting/latticeDraw.py +0 -199
- simba_accelerator-0.5.0/simba/Modules/plotting/multiAxisPlot.py +0 -226
- simba_accelerator-0.5.0/simba/Modules/plotting/multiPlot.py +0 -308
- simba_accelerator-0.5.0/simba/Modules/pmd_units.py +0 -522
- simba_accelerator-0.5.0/simba/Modules/symmlinks.py +0 -227
- simba_accelerator-0.5.0/simba/Modules/units.py +0 -559
- simba_accelerator-0.5.0/simba/__init__.py +0 -0
- simba_accelerator-0.5.0/simba/yaml_checker.py +0 -29
- simba_accelerator-0.5.0/simba_accelerator.egg-info/scm_version.json +0 -8
- simba_accelerator-0.5.0/tests/CLARA/Settings/250pC/1/constants.py +0 -6
- simba_accelerator-0.5.0/tests/CLARA/src/FEBE_Simple_NM.py +0 -1286
- simba_accelerator-0.5.0/tests/CLARA/test.py +0 -27
- simba_accelerator-0.5.0/tests/ISIS/LEBT/testing_SimFrame_LEBT.py +0 -75
- simba_accelerator-0.5.0/tests/ISIS/MEBT/testing_SimFrame_MEBT.py +0 -73
- simba_accelerator-0.5.0/tests/framework_test.py +0 -448
- simba_accelerator-0.5.0/tests/twiss.py +0 -10
- simba_accelerator-0.5.0/tests/xopt_example/example.yaml +0 -39
- simba_accelerator-0.5.0/tests/xopt_test.py +0 -10
- simba_accelerator-0.5.0/unit_tests/.coverage +0 -0
- simba_accelerator-0.5.0/unit_tests/test_field.py +0 -224
- simba_accelerator-0.5.0/unit_tests/test_framework_objects.py +0 -101
- simba_accelerator-0.5.0/unit_tests/test_track.py +0 -281
- simba_accelerator-0.5.0/unit_tests/test_twiss.py +0 -31
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/.github/workflows/python-publish.yml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/.github/workflows/tests.yml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/LICENSE +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/MANIFEST.in +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/Makefile +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/README.md +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/.venv/pyvenv.cfg +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/Makefile +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/make.bat +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/rebuild.sh +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/requirements.txt +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/Framework.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/Framework_objects.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/assets/elegant-fodo.png +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/assets/ocelot-fodo.png +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/examples/notebooks/CLA-S02-DIA-SCR-03.openpmd.hdf5 +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/examples/notebooks/beams_example.ipynb +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/examples/notebooks/getting_started.ipynb +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/examples/notebooks/utility_functions.ipynb +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/installation.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/references.bib +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.ASTRA.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.CSRTrack.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.Elegant.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.GPT.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.Generators.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Codes.OPAL.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/docs/source/simba.Modules.Beams.Particles.rst +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/examples/notebooks/CLA-S02-DIA-SCR-03.openpmd.hdf5 +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/examples/notebooks/beams_example.ipynb +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/examples/notebooks/getting_started.ipynb +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/examples/notebooks/params.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/examples/notebooks/utility_functions.ipynb +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/make.bat +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/meta.yml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/readthedocs.yml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/setup.cfg +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/setup.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/.gitignore +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/ASTRA/ASTRARules.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/ASTRA/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/CSRTrack/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/CSRTrack/csrtrack_defaults.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Cheetah/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Cheetah/cheetah_defaults.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Elegant/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Elegant/commands_Elegant.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Elegant/keyword_conversion_rules_elegant.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/GPT/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/aliases.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/astra.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/elegant.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/gpt.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/keywords.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/opal.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Generators/species.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Genesis/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/Genesis/commands_Genesis.yaml +0 -0
- {simba_accelerator-0.5.0/simba/Codes/MADX → simba_accelerator-0.6.0/simba/Codes/OPAL}/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/OPAL/commands_Opal.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Codes/OPAL/globals_Opal.yaml +0 -0
- {simba_accelerator-0.5.0/simba/Codes/OPAL → simba_accelerator-0.6.0/simba/Codes/Ocelot}/__init__.py +0 -0
- {simba_accelerator-0.5.0/simba/Codes/Ocelot → simba_accelerator-0.6.0/simba/Codes/Wake_T}/__init__.py +0 -0
- {simba_accelerator-0.5.0/simba/Codes/Wake_T → simba_accelerator-0.6.0/simba/Codes/Xsuite}/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Framework_elements.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/.gitignore +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/Beams/Particles/mve.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/constants.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Modules/gdf_emit.py +0 -0
- {simba_accelerator-0.5.0/simba/Codes/Xsuite → simba_accelerator-0.6.0/simba/Modules/plotting}/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/Vision_Mission.docx +0 -0
- {simba_accelerator-0.5.0/simba/Modules/plotting → simba_accelerator-0.6.0/simba}/__init__.py +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/elementkeywords.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba/hosts.yaml +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba_accelerator.egg-info/dependency_links.txt +0 -0
- {simba_accelerator-0.5.0 → simba_accelerator-0.6.0}/simba_accelerator.egg-info/top_level.txt +0 -0
- /simba_accelerator-0.5.0/docs/=3.8 → /simba_accelerator-0.6.0/unit_tests/downloaded_files/dashboard.lock +0 -0
|
@@ -19,6 +19,8 @@ SimulationFramework/Examples/S2EBunchPrePostCombined_v2.sdds
|
|
|
19
19
|
SimulationFramework/Examples/S2EBunchPrePostCombined.astra
|
|
20
20
|
SAMM3.0/Examples
|
|
21
21
|
examples/notebooks/getting_started/
|
|
22
|
+
examples/fbpic_lwfa/
|
|
23
|
+
examples/ring_studies/runs/
|
|
22
24
|
tests/CLARA/Basefiles/Base_250pC/CLA-S02-SIM-APER-01.astra
|
|
23
25
|
tests/CLARA/Basefiles/Base_250pC/CLA-S02-SIM-APER-01.gdf
|
|
24
26
|
tests/CLARA/Basefiles/Base_250pC/CLA-S02-SIM-APER-01.ocelot.npz
|
|
@@ -30,5 +32,13 @@ docs/source/examples/notebooks/getting_started/*
|
|
|
30
32
|
docs/source/examples/notebooks/utility_functions/*
|
|
31
33
|
docs/source/examples/notebooks/changes.yaml
|
|
32
34
|
docs/source/examples/notebooks/params.yaml
|
|
33
|
-
|
|
34
35
|
M1.openpmd.hdf5
|
|
36
|
+
unit_tests/S.json
|
|
37
|
+
unit_tests/JFEL-S02-SIM-APER-01.openpmd.hdf5
|
|
38
|
+
S.json
|
|
39
|
+
JFEL-S02-SIM-APER-01.openpmd.hdf5
|
|
40
|
+
# seleniumbase's pytest plugin, if installed, drops this under xdist
|
|
41
|
+
downloaded_files/
|
|
42
|
+
.coverage
|
|
43
|
+
checkpoint_restart.dat
|
|
44
|
+
.benchmarks/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: simba-accelerator
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.6.0
|
|
4
4
|
Summary: A python framework for particle accelerator simulations
|
|
5
5
|
Author-email: James Jones <james.jones@stfc.ac.uk>
|
|
6
6
|
Maintainer-email: James Jones <james.jones@stfc.ac.uk>, Alex Brynes <alexander.brynes@stfc.ac.uk>, Mark Johnson <mark.johnson@stfc.ac.uk>
|
|
@@ -36,8 +36,9 @@ Requires-Dist: pyfftw
|
|
|
36
36
|
Requires-Dist: numexpr
|
|
37
37
|
Requires-Dist: openpmd-beamphysics>=0.10
|
|
38
38
|
Requires-Dist: xopt
|
|
39
|
-
Requires-Dist: laura-accelerator>=1.0
|
|
40
|
-
Requires-Dist:
|
|
39
|
+
Requires-Dist: laura-accelerator>=1.1.0
|
|
40
|
+
Requires-Dist: pytao>=1.0.0
|
|
41
|
+
Requires-Dist: nafflib
|
|
41
42
|
Provides-Extra: simcodes
|
|
42
43
|
Requires-Dist: ocelot-desy==25.06.0; extra == "simcodes"
|
|
43
44
|
Requires-Dist: xsuite>=0.39.0; extra == "simcodes"
|
|
@@ -179,7 +179,5 @@ This will then allow :mod:`SIMBA` to call the correct version of ``ELEGANT``.
|
|
|
179
179
|
Citing the codes used
|
|
180
180
|
---------------------
|
|
181
181
|
|
|
182
|
-
Please consider citing the code(s) used if any work performed with :mod:`SIMBA` leads to a
|
|
183
|
-
|
|
184
|
-
.. bibliography::
|
|
185
|
-
:style: unsrt
|
|
182
|
+
Please consider citing the code(s) used if any work performed with :mod:`SIMBA` leads to a
|
|
183
|
+
publication. The citations above resolve against the :ref:`reference list <references>`.
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
# Options for Pydantic models
|
|
16
16
|
# https://autodoc-pydantic.readthedocs.io/en/stable/users/configuration.html
|
|
17
17
|
|
|
18
|
+
import importlib.util
|
|
18
19
|
import os
|
|
19
20
|
import sys
|
|
20
21
|
import subprocess
|
|
@@ -80,6 +81,7 @@ templates_path = ["_templates"] # list of paths that contain extra templates
|
|
|
80
81
|
add_function_parentheses = True # display function and method names with parentheses
|
|
81
82
|
add_module_names = False # don't include module names before object names
|
|
82
83
|
pygments_style = "sphinx" # style for highlighting of source code
|
|
84
|
+
numfig = True # number figures and tables, so :numref: resolves
|
|
83
85
|
bibtex_bibfiles = ["references.bib"]
|
|
84
86
|
|
|
85
87
|
# set automodapi options
|
|
@@ -118,14 +120,33 @@ autodoc_pydantic_model_show_validator_members = (
|
|
|
118
120
|
False # don't include documentation for validator methods
|
|
119
121
|
)
|
|
120
122
|
|
|
121
|
-
|
|
123
|
+
# Only mock what this machine cannot actually import. Mocking a module that *is*
|
|
124
|
+
# installed is not free: a mocked ``pydantic`` makes ``BaseModel`` a stub, so every
|
|
125
|
+
# LAURA model fails to build and autodoc then drops the whole of ``simba.Framework``,
|
|
126
|
+
# ``Framework_elements``, ``Framework_objects`` and most of ``simba.Codes``.
|
|
127
|
+
_optional_imports = [
|
|
122
128
|
"pydantic",
|
|
123
129
|
"ocelot",
|
|
124
130
|
"cheetah",
|
|
125
|
-
"PyQt5",
|
|
126
|
-
"PyQt4",
|
|
127
131
|
"ctypes",
|
|
128
|
-
|
|
132
|
+
]
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
def _is_importable(name: str) -> bool:
|
|
136
|
+
"""Whether a module can be found without importing it.
|
|
137
|
+
|
|
138
|
+
:param str name: Name of the module to look for
|
|
139
|
+
:returns: True if the module is installed
|
|
140
|
+
"""
|
|
141
|
+
try:
|
|
142
|
+
return importlib.util.find_spec(name) is not None
|
|
143
|
+
except (ImportError, ModuleNotFoundError, ValueError):
|
|
144
|
+
return False
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
autodoc_mock_imports = [
|
|
148
|
+
name for name in _optional_imports if not _is_importable(name)
|
|
149
|
+
]
|
|
129
150
|
|
|
130
151
|
autodoc_default_options = {
|
|
131
152
|
"exclude-members": ",".join([
|
|
@@ -169,9 +190,11 @@ intersphinx_mapping = {
|
|
|
169
190
|
|
|
170
191
|
# set HTML output options
|
|
171
192
|
html_theme = "sphinx_rtd_theme" # set HTML themse (read the docs theme)
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
193
|
+
# No logo, favicon or static assets are in the tree yet; set these again when
|
|
194
|
+
# they are, rather than warning on every build for files that do not exist.
|
|
195
|
+
# html_logo = "icon.png" # set logo for top-left corner of HTML pages
|
|
196
|
+
# html_favicon = "favicon.ico" # set HTML favicon
|
|
197
|
+
# html_static_path = ["_static"] # path to custom static files
|
|
175
198
|
|
|
176
199
|
# set mathjax equation rendering options
|
|
177
200
|
mathjax3_config = {"chtml": {"displayAlign": "left", "displayIndent": "2em"}}
|
|
@@ -216,7 +216,6 @@ python (i.e. **Ocelot**, **Cheetah** etc.), the :mod:`SimCodes` directory must b
|
|
|
216
216
|
)
|
|
217
217
|
framework.loadSettings(settings=settings)
|
|
218
218
|
framework.global_parameters["beam"] = beam
|
|
219
|
-
framework["FODO"].lsc_enable = False
|
|
220
219
|
framework["FODO"].csr_enable = False
|
|
221
220
|
framework.set_lattice_prefix("FODO", "../")
|
|
222
221
|
|
|
@@ -18,6 +18,10 @@ It provides a wrapper for several well-known particle tracking codes:
|
|
|
18
18
|
* `Cheetah <https://github.com/desy-ml/cheetah>`_ :cite:`Cheetah`
|
|
19
19
|
* `Xsuite <https://github.com/xsuite>`_ :cite:`Xsuite`
|
|
20
20
|
* `Wake-T <https://github.com/AngelFP/Wake-T>`_ :cite:`WakeT`
|
|
21
|
+
* `MAD-X <https://mad.web.cern.ch/mad/>`_
|
|
22
|
+
* `Bmad <https://www.classe.cornell.edu/bmad/>`_
|
|
23
|
+
* `OPAL <https://amas.web.psi.ch/opal/>`_
|
|
24
|
+
* `Genesis <https://github.com/svenreiche/Genesis-1.3-Version4>`_
|
|
21
25
|
|
|
22
26
|
Setup
|
|
23
27
|
-----
|
|
@@ -31,6 +35,7 @@ Setup
|
|
|
31
35
|
installation
|
|
32
36
|
getting-started
|
|
33
37
|
loading-a-lattice
|
|
38
|
+
ring-studies
|
|
34
39
|
SimCodes
|
|
35
40
|
|
|
36
41
|
|
|
@@ -64,6 +69,7 @@ We are also happy to help with installation and setting up your accelerator latt
|
|
|
64
69
|
Framework
|
|
65
70
|
Framework_objects
|
|
66
71
|
Framework_elements
|
|
72
|
+
simba
|
|
67
73
|
simba.Codes
|
|
68
74
|
simba.Modules
|
|
69
75
|
|
|
@@ -74,6 +80,8 @@ Indices and tables
|
|
|
74
80
|
* :ref:`modindex`
|
|
75
81
|
* :ref:`search`
|
|
76
82
|
|
|
83
|
+
.. _references:
|
|
84
|
+
|
|
77
85
|
References
|
|
78
86
|
----------
|
|
79
87
|
|
|
@@ -61,6 +61,8 @@ for the CLARA :cite:`PhysRevAccelBeams.23.044801` :cite:`PhysRevAccelBeams.27.04
|
|
|
61
61
|
layout: /path/to/laura-lattices/CLARA/layouts.yaml
|
|
62
62
|
section: /path/to/laura-lattices/CLARA/sections.yaml
|
|
63
63
|
element_list: /path/to/laura-lattices/CLARA/YAML/
|
|
64
|
+
functional_definitions: /path/to/laura-lattices/CLARA/functional_definitions.yaml
|
|
65
|
+
resolve_functional: false
|
|
64
66
|
|
|
65
67
|
This lattice definition would produce several output files (called ``injector400.in``, ``Linac.lte``,
|
|
66
68
|
and ``FEBE.py``) for running in the **ASTRA**, **Elegant** and **Ocelot** beam tracking codes.
|
|
@@ -71,9 +73,48 @@ As this simulation starts from the cathode, the ``input`` definition is required
|
|
|
71
73
|
`injector400` ``file`` block. An alternative method for starting is to specify ``input/particle_definition`` to
|
|
72
74
|
point to an existing beam file.
|
|
73
75
|
|
|
74
|
-
For `follow-on` lattice runs, it is sufficient to define the ``output: start_element``, which should match the ``output: end_element`` definition
|
|
76
|
+
For `follow-on` lattice runs, it is sufficient to define the ``output: start_element``, which should match the ``output: end_element`` definition
|
|
75
77
|
from the previous ``file`` block.
|
|
76
78
|
|
|
79
|
+
.. _functional-parameters:
|
|
80
|
+
|
|
81
|
+
Functional Parameters
|
|
82
|
+
---------------------
|
|
83
|
+
|
|
84
|
+
Certain element attributes in `LAURA <https://github.com/astec-stfc/laura/>`_ (for
|
|
85
|
+
example magnet strengths, dipole bend and edge angles, cavity phases and field
|
|
86
|
+
amplitudes) can be defined *functionally* — as a string naming a shared value —
|
|
87
|
+
rather than as a fixed number. The definition file records the numeric values:
|
|
88
|
+
|
|
89
|
+
.. code-block:: yaml
|
|
90
|
+
|
|
91
|
+
# functional_definitions.yaml
|
|
92
|
+
CLA-VBC-MAG-DIP-01_angle: 0.1305
|
|
93
|
+
linac1_phase: -21.0
|
|
94
|
+
|
|
95
|
+
An element then refers to a definition by name (e.g. a dipole ``angle`` set to
|
|
96
|
+
``"CLA-VBC-MAG-DIP-01_angle"``). This is convenient when several elements share a
|
|
97
|
+
value, or when a parameter is driven by an external study or optimiser.
|
|
98
|
+
|
|
99
|
+
Two settings control this behaviour in the ``.def`` file:
|
|
100
|
+
|
|
101
|
+
* ``functional_definitions`` — a mapping of names to numeric values, or a path to
|
|
102
|
+
a ``YAML`` file holding such a mapping. It is passed through to the
|
|
103
|
+
:mod:`LAURA` ``MachineModel``/``SectionLattice`` and cascaded to the whole
|
|
104
|
+
machine. Any element that references an undefined name raises an error, naming
|
|
105
|
+
the missing parameter and the element that uses it.
|
|
106
|
+
* ``resolve_functional`` — a boolean (default ``false``). When ``false``,
|
|
107
|
+
functional attributes are kept symbolic and exported as such to codes that
|
|
108
|
+
support them (the ELEGANT ``% <value> sto <name>`` rpn store and the Xsuite
|
|
109
|
+
``Environment`` variables); codes that do not support symbolic parameters
|
|
110
|
+
always receive the resolved numbers. When ``true``, the values are resolved to
|
|
111
|
+
numbers everywhere (baked in).
|
|
112
|
+
|
|
113
|
+
Both settings are optional and default to "no functional definitions" and
|
|
114
|
+
``resolve_functional: false`` respectively, so existing lattices are unaffected.
|
|
115
|
+
See the `LAURA documentation <https://github.com/astec-stfc/laura/>`_ for full
|
|
116
|
+
details of the functional-parameter mechanism.
|
|
117
|
+
|
|
77
118
|
|
|
78
119
|
Running SIMBA
|
|
79
120
|
-------------
|