https://github.com/electronsandstuff/vscode-bmad

https://github.com/electronsandstuff/vscode-bmad

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/electronsandstuff/vscode-bmad
• Owner: electronsandstuff
• License: bsd-3-clause
• Created: 2024-08-21T07:17:22.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-09-10T22:27:32.000Z (9 months ago)
• Last Synced: 2025-09-11T02:17:02.365Z (9 months ago)
• Size: 299 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# VSCode Bmad Language Extension

This extension provides language support for [Bmad](https://github.com/bmad-sim/bmad-ecosystem), the particle accelerator design toolkit.

Currently, syntax highlighting is supported for Bmad lattice files.

Future work will focus on also covering scripts and configuration files for tao.

## Installation

Clone the repo or copy release into your plugins folder.

#### On Linux/Mac

Run the following commands and restart VSCode.

```

cd $HOME/.vscode/extensions

git clone https://github.com/electronsandstuff/vscode-bmad

```

#### On Windows

Copy the repo into `%USERPROFILE%\.vscode\extensions` and restart VSCode.

## Features

The extension currently supports the following features for Bmad lattice files.

 * Support for VSCode bulk commenting

 * Syntax highlighting for the following entities

   * Comments

   * Element names (including following all rules in Bmad manual)

   * Element attribute assignements

   * Element definitions

   * Line definitions

   * Constant definitions

   * Call statements

   * Use statements

   * Print statements

   * Title statements

   * Literals (string, numeric, boolean)

   * Bmad keywords

   * Species names

   * Numerical constants

   * Built-in numerical functions

## Screenshots

![Example of syntax highlighting 1](assets/syntax-highlighting-1.png)

![Example of syntax highlighting 2](assets/syntax-highlighting-2.png)

![Example of syntax highlighting 3](assets/syntax-highlighting-3.png)

![Example of syntax highlighting 4](assets/syntax-highlighting-4.png)

![Example of syntax highlighting 5](assets/syntax-highlighting-5.png)

## Contributing

If there is a feature you would like to see implemented, or you notice a problem with the current package please leave us a note in the issues tab on Github.

Please leave as much detail as possible and screenshots where appropriate (especially if it is a syntax highlighting problem).

All feedback is appreciated!