laura-accelerator 0.2.0__tar.gz

laura_accelerator-0.2.0/.github/workflows/python-publish.yml

@@ -0,0 +1,44 @@
+name: Publish Python Package to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"  # triggers on tags like v0.1.0
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      # 1️⃣ Checkout full git history including tags
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          tags: true
+
+      # 2️⃣ Set up Python
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      # 3️⃣ Install build tools
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine setuptools_scm
+
+      # 4️⃣ Optional: print detected version
+      - name: Check detected version
+        run: python -c "import setuptools_scm; print(setuptools_scm.get_version())"
+
+      # 5️⃣ Build distributions
+      - name: Build distributions
+        run: python -m build
+
+      # 6️⃣ Publish to PyPI
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: python -m twine upload --non-interactive dist/*
+

laura_accelerator-0.2.0/.gitignore

@@ -0,0 +1,172 @@
+# PAdantic
+# Machines/
+Output/
+testYAML/
+YAML_OLD/
+Basefiles/
+to_CATAP/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.vscode
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+#vscode
+./vscode
+PAdantic/Importers/~$CLARA Magnet Table v6.xlsx

laura_accelerator-0.2.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: laura-accelerator
+Version: 0.2.0
+Summary: A standardized lattice format for particle accelerators
+Author-email: James Jones <james.jones@stfc.ac.uk>
+Maintainer-email: James Jones <james.jones@stfc.ac.uk>, Alex Brynes <alexander.brynes@stfc.ac.uk>, Mark Johnson <mark.johnson@stfc.ac.uk>, Matt King <matthew.king@stfc.ac.uk>
+Project-URL: Homepage, https://github.com/astec-stfc/laura
+Project-URL: Repository, https://github.com/astec-stfc/laura.git
+Project-URL: Issues, https://github.com/astec-stfc/laura/-/issues/
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2
+Requires-Dist: pyyaml>=6
+Requires-Dist: numpy>=1.26
+Requires-Dist: scipy>=1.15
+Requires-Dist: munch>=4
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: sphinx_autodoc_typehints>=3; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Dynamic: requires-python
+
+# LAURA: Lattice Architecture for a Unified Representation of Accelerators
+
+**LAURA** is a Python package for describing, simulating, and controlling particle accelerator lattices. It provides a standardized, extensible data model for elements, sections, layouts, and full machine models.
+
+---
+
+## Architecture Overview
+
+LAURA organizes accelerator elements using a hierarchical structure:
+
+### Element Structure
+
+![LAURA Element Structure](docs/source/Architecture/assets/element-structure.png)
+
+- **baseElement**: Core identification (name, hardware_class, hardware_type, machine_area)
+- **Element**: Extends with simulation, controls, electrical, manufacturer info
+- **PhysicalBaseElement**: Adds position, rotation, length, error, survey
+
+### Lattice Structure
+
+![LAURA Lattice Structure](docs/source/Architecture/assets/lattice-structure.png)
+
+- **ElementList**: Container for elements
+- **SectionLattice**: Ordered list of elements (a section of the beamline)
+- **MachineLayout**: Sequence of sections (a full beam path)
+- **MachineModel**: All layouts, sections, and elements (the full accelerator)
+
+---
+
+## Quick Examples
+
+### Create a Basic Element
+
+```python
+from laura.models.element import baseElement
+
+element = baseElement(
+    name="QUAD-01",
+    hardware_class="Magnet",
+    hardware_type="Quadrupole",
+    machine_area="LINAC-1"
+)
+print(element.name)  # "QUAD-01"
+```
+
+### Element with Physical Properties
+
+```python
+from laura.models.element import PhysicalBaseElement
+from laura.models.physical import PhysicalElement, Position
+
+cavity = PhysicalBaseElement(
+    name="CAV-01",
+    hardware_class="RF",
+    hardware_type="Cavity",
+    machine_area="LINAC-1",
+    physical=PhysicalElement(
+        length=1.0,
+        middle=Position(x=0, y=0, z=5.0)
+    )
+)
+print(cavity.physical.length)  # 1.0
+```
+
+### Create a Section Lattice
+
+```python
+from laura.models.elementList import SectionLattice, ElementList
+
+section = SectionLattice(
+    name="INJECTOR",
+    order=["BPM-01", "QUAD-01"],
+    elements=ElementList(elements={
+        "BPM-01": element,
+        "QUAD-01": cavity
+    })
+)
+print(section.names)  # ["BPM-01", "QUAD-01"]
+```
+
+### Build a Machine Layout
+
+```python
+from laura.models.elementList import MachineLayout
+
+layout = MachineLayout(
+    name="MainBeamline",
+    sections={"INJECTOR": section}
+)
+print(layout.names)  # ["INJECTOR"]
+```
+
+### Full Machine Model
+
+```python
+from laura.models.elementList import MachineModel
+
+model = MachineModel(
+    elements={"QUAD-01": element, "CAV-01": cavity}
+)
+print(list(model.sections.keys()))  # ["LINAC-1"]
+```
+
+---
+
+## Translator Module
+
+LAURA includes a translator system for exporting accelerator models to various simulation codes, 
+such as ASTRA, GPT, Elegant, CSRTrack, Ocelot, Xsuite, Wake-T, and Genesis.
+
+- Translate individual elements, sections, layouts, or full machine models.
+- Export to code-specific formats and objects.
+- Automatically manage drift spaces, field maps, and code-specific configuration.
+
+**Example: Export a section to Elegant and Ocelot**
+
+```python
+from laura.translator.converters.section import SectionLatticeTranslator
+
+translator = SectionLatticeTranslator.from_section(section)
+translator.directory = "./output"
+
+elegant_string = translator.to_elegant(charge=1e-9)
+ocelot_lattice = translator.to_ocelot(save=True)
+```
+
+See the [Translator documentation](docs/source/Translator.rst) for details and more examples.
+
+---
+
+## Features
+
+- **Hierarchical lattice structure**: elements → sections → layouts → machine
+- **Flexible element definition**: physical, simulation, controls, electrical, manufacturer
+- **Extensible API**: add new element types and metadata
+- **Simulation & controls integration**: store simulation parameters and control variables
+- **Export to simulation codes** via the Translator module
+
+---
+
+---
+
+## Installation
+
+Install LAURA from PyPI:
+
+```bash
+pip install laura-accelerator
+```
+
+Or add to your `requirements.txt`:
+
+```
+laura-accelerator
+```
+
+## Documentation
+
+- [Element Definition](docs/source/Architecture/Element.rst)
+- [Lattice Structure](docs/source/Architecture/Lattice.rst)
+- [Translator Module](docs/source/Translator.rst)
+- [Examples](docs/source/Examples.rst)
+
+---
+
+## Contributing
+
+Issues and pull requests are welcome! See [GitHub Issues](https://github.com/astec-stfc/laura/issues).
+
+---

laura_accelerator-0.2.0/README.md

@@ -0,0 +1,170 @@
+# LAURA: Lattice Architecture for a Unified Representation of Accelerators
+
+**LAURA** is a Python package for describing, simulating, and controlling particle accelerator lattices. It provides a standardized, extensible data model for elements, sections, layouts, and full machine models.
+
+---
+
+## Architecture Overview
+
+LAURA organizes accelerator elements using a hierarchical structure:
+
+### Element Structure
+
+![LAURA Element Structure](docs/source/Architecture/assets/element-structure.png)
+
+- **baseElement**: Core identification (name, hardware_class, hardware_type, machine_area)
+- **Element**: Extends with simulation, controls, electrical, manufacturer info
+- **PhysicalBaseElement**: Adds position, rotation, length, error, survey
+
+### Lattice Structure
+
+![LAURA Lattice Structure](docs/source/Architecture/assets/lattice-structure.png)
+
+- **ElementList**: Container for elements
+- **SectionLattice**: Ordered list of elements (a section of the beamline)
+- **MachineLayout**: Sequence of sections (a full beam path)
+- **MachineModel**: All layouts, sections, and elements (the full accelerator)
+
+---
+
+## Quick Examples
+
+### Create a Basic Element
+
+```python
+from laura.models.element import baseElement
+
+element = baseElement(
+    name="QUAD-01",
+    hardware_class="Magnet",
+    hardware_type="Quadrupole",
+    machine_area="LINAC-1"
+)
+print(element.name)  # "QUAD-01"
+```
+
+### Element with Physical Properties
+
+```python
+from laura.models.element import PhysicalBaseElement
+from laura.models.physical import PhysicalElement, Position
+
+cavity = PhysicalBaseElement(
+    name="CAV-01",
+    hardware_class="RF",
+    hardware_type="Cavity",
+    machine_area="LINAC-1",
+    physical=PhysicalElement(
+        length=1.0,
+        middle=Position(x=0, y=0, z=5.0)
+    )
+)
+print(cavity.physical.length)  # 1.0
+```
+
+### Create a Section Lattice
+
+```python
+from laura.models.elementList import SectionLattice, ElementList
+
+section = SectionLattice(
+    name="INJECTOR",
+    order=["BPM-01", "QUAD-01"],
+    elements=ElementList(elements={
+        "BPM-01": element,
+        "QUAD-01": cavity
+    })
+)
+print(section.names)  # ["BPM-01", "QUAD-01"]
+```
+
+### Build a Machine Layout
+
+```python
+from laura.models.elementList import MachineLayout
+
+layout = MachineLayout(
+    name="MainBeamline",
+    sections={"INJECTOR": section}
+)
+print(layout.names)  # ["INJECTOR"]
+```
+
+### Full Machine Model
+
+```python
+from laura.models.elementList import MachineModel
+
+model = MachineModel(
+    elements={"QUAD-01": element, "CAV-01": cavity}
+)
+print(list(model.sections.keys()))  # ["LINAC-1"]
+```
+
+---
+
+## Translator Module
+
+LAURA includes a translator system for exporting accelerator models to various simulation codes, 
+such as ASTRA, GPT, Elegant, CSRTrack, Ocelot, Xsuite, Wake-T, and Genesis.
+
+- Translate individual elements, sections, layouts, or full machine models.
+- Export to code-specific formats and objects.
+- Automatically manage drift spaces, field maps, and code-specific configuration.
+
+**Example: Export a section to Elegant and Ocelot**
+
+```python
+from laura.translator.converters.section import SectionLatticeTranslator
+
+translator = SectionLatticeTranslator.from_section(section)
+translator.directory = "./output"
+
+elegant_string = translator.to_elegant(charge=1e-9)
+ocelot_lattice = translator.to_ocelot(save=True)
+```
+
+See the [Translator documentation](docs/source/Translator.rst) for details and more examples.
+
+---
+
+## Features
+
+- **Hierarchical lattice structure**: elements → sections → layouts → machine
+- **Flexible element definition**: physical, simulation, controls, electrical, manufacturer
+- **Extensible API**: add new element types and metadata
+- **Simulation & controls integration**: store simulation parameters and control variables
+- **Export to simulation codes** via the Translator module
+
+---
+
+---
+
+## Installation
+
+Install LAURA from PyPI:
+
+```bash
+pip install laura-accelerator
+```
+
+Or add to your `requirements.txt`:
+
+```
+laura-accelerator
+```
+
+## Documentation
+
+- [Element Definition](docs/source/Architecture/Element.rst)
+- [Lattice Structure](docs/source/Architecture/Lattice.rst)
+- [Translator Module](docs/source/Translator.rst)
+- [Examples](docs/source/Examples.rst)
+
+---
+
+## Contributing
+
+Issues and pull requests are welcome! See [GitHub Issues](https://github.com/astec-stfc/laura/issues).
+
+---

laura_accelerator-0.2.0/Testing/.gitignore

@@ -0,0 +1,21 @@
+build/
+dist/
+*.egg*/
+magnet-table/magnet-table.ini
+*.pyc
+*.pyc
+MagnetApp/GUI_FileLoad.pyc
+magnet-table/.idea/*.*
+magnet-table/tmp/*.*
+magnet-table/rf_sol_gui.py
+magnet-table/src/pip-delete-this-directory.txt
+.idea
+SimulationFramework/Examples/S2EBunchPrePostCombined_v3.sdds
+SimulationFramework/Examples/S2EBunchPrePostCombined_v2.sdds
+SimulationFramework/Examples/S2EBunchPrePostCombined.astra
+SAMM3.0/Examples
+*checkpoint.ipynb
+*.pyc*
+*Untitled*
+
+to_CATAP/

laura_accelerator-0.2.0/Testing/FEBE_2_Bunches.def

@@ -0,0 +1,42 @@
+generator:
+  default: clara_400_3ps
+files:
+  injector400:
+    code: ASTRA
+    charge:
+      cathode: True
+      space_charge_mode: 2D
+      mirror_charge: True
+    input:
+      particle_definition: 'initial_distribution'
+    output:
+      zstart: 0
+      end_element: CLA-S02-SIM-APER-01
+  FEBE:
+    code: elegant
+    charge:
+      cathode: False
+      space_charge_mode: 3D
+    output:
+      start_element: CLA-S02-SIM-APER-01
+      end_element: CLA-FED-SIM-DUMP-01-START
+groups:
+  bunch_compressor:
+    type: chicane
+    elements: [CLA-VBC-MAG-DIP-01, CLA-VBC-MAG-DIP-02, CLA-VBC-MAG-DIP-03, CLA-VBC-MAG-DIP-04]
+  FODO_F:
+    type: element_group
+    elements: [CLA-FEA-MAG-QUAD-01, CLA-FEA-MAG-QUAD-03, CLA-FEA-MAG-QUAD-05, CLA-FEA-MAG-QUAD-07, CLA-FEA-MAG-QUAD-09, CLA-FEA-MAG-QUAD-11]
+  FODO_D:
+    type: element_group
+    elements: [CLA-FEA-MAG-QUAD-02, CLA-FEA-MAG-QUAD-04, CLA-FEA-MAG-QUAD-06, CLA-FEA-MAG-QUAD-08, CLA-FEA-MAG-QUAD-10, CLA-FEA-MAG-QUAD-12]
+  ARC_R56:
+    type: r56_group
+    elements: [FODO_F, FODO_D]
+    ratios: [1.5924900169720815 - 2.38 * (r56 - 0.007714832782173741), -1.1063900117914343 - 2.2 * (r56 - 0.007714832782173741)]
+    keys: [k1l, k1l]
+elements:
+  layout_file: Machines/CLARA/layouts.yaml
+  section_file: Machines/CLARA/sections.yaml
+  yaml_dir: Machines/CLARA/YAML
+  lattice: CLARA