Vectorised simulations

.github/workflows/format.yaml

@@ -6,10 +6,10 @@ jobs:
   format:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
 

.github/workflows/pytest.yaml

@@ -10,9 +10,9 @@ jobs:
         python-version: ["3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.vscode/ltex.dictionary.en-GB.txt

@@ -0,0 +1,17 @@
+PyPI
+undoc-members
+DESY
+Bmad
+Twiss
+maxdepth
+CUDA
+Chenran
+Eichler
+Santamaria
+@cr-xu
+LatticeJSON
+docstring
+@FelixTheilen
+pytest
+isort
+docstrings

.vscode/ltex.disabledRules.en-GB.txt

@@ -0,0 +1,9 @@
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S
+OXFORD_SPELLING_Z_NOT_S

.vscode/ltex.hiddenFalsePositives.en-GB.txt

@@ -0,0 +1,36 @@
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qwhere the optional keyword argument \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q is the incoming beam represented by the reference particles.\\E$"}
+{"rule":"OXFORD_SPELLING_Z_NOT_S","sentence":"^\\QGradient-based optimisation using Cheetah and PyTorch\\E$"}
+{"rule":"OXFORD_SPELLING_Z_NOT_S","sentence":"^\\QCheetah is a differentiable beam dynamics simulation engine, making it ideally suited to gradient-based optimisation, for example for optimisation magnet settings, lattice geometries or even for system identification.\\E$"}
+{"rule":"COMMA_PARENTHESIS_WHITESPACE","sentence":"^\\Q, pass the file path to \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q.\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QUtils\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qutils\n:members:\n:undoc-members:\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qconverters.nocelot\n:members:\n:undoc-members:\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QNOcelot\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QLatticeJSON\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qlatticejson\n:members:\n:undoc-members:\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QDontBmad\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qconverters.dontbmad\n:members:\n:undoc-members:\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QAstralavista\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qconverters.astralavista\n:members:\n:undoc-members:\\E$"}
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qbash\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Q:maxdepth: 2\n:caption: Examples\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qexamples/simple\nexamples/convert\nexamples/gradientbased\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qaccelerator\nastralavista\ndontbmad\nerror\nlatticejson\nnocelot\nparticles\ntrack_methods\nutils\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qbibtex\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Qbibtex\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\Q@inproceedings{stein2022accelerating,\nauthor = {Stein, Oliver and\nKaiser, Jan and\nEichler, Annika},\ntitle = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},\nbooktitle = {Proceedings of the 13th International Particle Accelerator Conference},\nyear = {2022},\nurl = {https://github.com/desy-ml/cheetah},\n}\\E$"}
+{"rule":"COMMA_PARENTHESIS_WHITESPACE","sentence":"^\\Q@inproceedings{stein2022accelerating,\nauthor = {Stein, Oliver and\nKaiser, Jan and\nEichler, Annika},\ntitle = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},\nbooktitle = {Proceedings of the 13th International Particle Accelerator Conference},\nyear = {2022},\nurl = {https://github.com/desy-ml/cheetah},\n}\\E$"}
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qpip install -e .\\E$"}
+{"rule":"COMMA_PARENTHESIS_WHITESPACE","sentence":"^\\Qpip install -e .\\E$"}
+{"rule":"ENGLISH_WORD_REPEAT_RULE","sentence":"^\\Qpip install pre-commit\npre-commit install\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QConvert from Bmad lattices files (see #65) (@jank324)\nAdd proper transfer map for cavity (see #65) (@jank324, @cr-xu)\nTwiss parameter calculation and generate new beam from twiss parameter (see #62) (@jank324, @cr-xu)\nSaving and loading lattices from LatticeJSON (see #9) (@cr-xu)\nNested \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Qs can now be flattened (@jank324)\nOcelot converter adds support for \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q, \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q, \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q, \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q, \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q, \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q, \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q and \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q (see #78) (@jank324)\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QFix issue where multivariate_normal() crashes because cov is not positive-semidefinite.\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QFaster screen reading simulation by using torch.histogramdd()\\E$"}
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qv0.5.15 (2022-10-12)\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QAdd caching of Screen.reading to avoid expensive recomputation\\E$"}
+{"rule":"LC_AFTER_PERIOD","sentence":"^\\QAdd caching of Screen.reading to avoid expensive recomputation\\E$"}
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qv0.5.13 (2022-07-26)\\E$"}
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qv0.5.14 (2022-09-28)\\E$"}
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qv0.5.17 (2023-02-05)\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QImprove docstrings (@FelixTheilen)\nImplement better testing with pytest (@FelixTheilen)\nSetup formatting with \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q and \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q as well as \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q listing (@cr-xu)\nAdd type annotations (@jank324)\nSetup Sphinx documentation on readthedocs (@jank324)\\E$"}
+{"rule":"MORFOLOGIK_RULE_EN_GB","sentence":"^\\QFix dependencies on readthedocs (see #54) (@jank324)\nFix error when tracking \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q through segment on CPU (see #68) (@cr-xu)\\E$"}

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "spellright.language": [
+        "en_GB"
+    ],
+    "spellright.documentTypes": [
+        "markdown",
+        "latex",
+        "plaintext"
+    ],
+    "python.linting.flake8Enabled": true,
+    "python.linting.enabled": true,
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
+    "python.formatting.provider": "none",
+    "esbonio.sphinx.confDir": ""
+}

CHANGELOG.md

@@ -4,12 +4,20 @@
 
 ### 🚨 Breaking Changes
 
+- Cheetah is now vectorised. This means that you can run multiple simulations in parallel by passing a batch of beams and settings, resulting a number of interfaces being changed. For Cheetah developers this means that you now have to account for an arbitrary-dimensional tensor of most of the properties of you element, rather than a single value, vector or whatever else a property was before. (see #116) (@jank324)
+
 ### 🚀 Features
 
+- `CustomTransferMap` elements created by combining multiple other elements will now reflect that in their `name` attribute (see #100) (@jank324)
+
 ### 🐛 Bug fixes
 
+- Now all `Element` have a default length of `torch.zeros((1))`, fixing occasional issues with using elements without length, such as `Marker`, `BPM`, `Screen`, and `Aperture`. (see #143) (@cr-xu)
+
 ### 🐆 Other
 
+- Update versions of some steps used by GitHub actions to handle Node.js 16 end-of-life (@jank324)
+
 ## [v0.6.3](https://github.com/desy-ml/cheetah/releases/tag/v0.6.3) (2024-03-28)
 
 ### 🐛 Bug fixes

README.md

@@ -28,15 +28,15 @@ A sequence of accelerator elements (or a lattice) is called a `Segment` in _Chee
 segment = Segment(
     elements=[
         BPM(name="BPM1SMATCH"),
-        Drift(length=torch.tensor(1.0)),
+        Drift(length=torch.tensor([1.0])),
         BPM(name="BPM6SMATCH"),
-        Drift(length=torch.tensor(1.0)),
-        VerticalCorrector(length=torch.tensor(0.3), name="V7SMATCH"),
-        Drift(length=torch.tensor(0.2)),
-        HorizontalCorrector(length=torch.tensor(0.3), name="H10SMATCH"),
-        Drift(length=torch.tensor(7.0)),
-        HorizontalCorrector(length=torch.tensor(0.3), name="H12SMATCH"),
-        Drift(length=torch.tensor(0.05)),
+        Drift(length=torch.tensor([1.0])),
+        VerticalCorrector(length=torch.tensor([0.3]), name="V7SMATCH"),
+        Drift(length=torch.tensor([0.2])),
+        HorizontalCorrector(length=torch.tensor([0.3]), name="H10SMATCH"),
+        Drift(length=torch.tensor([7.0])),
+        HorizontalCorrector(length=torch.tensor([0.3]), name="H12SMATCH"),
+        Drift(length=torch.tensor([0.05])),
         BPM(name="BPM13SMATCH"),
     ]
 )