https://github.com/cern/lhc-vdm-editor

LHC VdM Scan files editor
https://github.com/cern/lhc-vdm-editor

Last synced: 12 months ago
JSON representation

LHC VdM Scan files editor

• Host: GitHub
• URL: https://github.com/cern/lhc-vdm-editor
• Owner: CERN
• License: apache-2.0
• Created: 2019-07-02T09:12:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-04-28T14:36:52.000Z (about 1 year ago)
• Last Synced: 2025-06-05T23:07:57.687Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 970 KB
• Stars: 1
• Watchers: 5
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# lhc-vdm-editor

A code and file editor for VdM scans.

![GitHub test status](https://github.com/CERN/lhc-vdm-editor/workflows/Tests/badge.svg)

![lhc-vdm-editor screenshot](https://user-images.githubusercontent.com/6304200/63919839-d1049680-ca3f-11e9-862a-dac7d8d756c7.png)

## Features

* A VdM code editor, including: 

  - Syntax highlighting

  - Syntax checking

  - Autocompletion

  - Auto generation of line numbers

  - VdM file headers and hints for VdM commands

* A file browser tracking files on a GitLab repository.

* Graphs containing simulations of expected beam position and luminosity.

* Generation of common VdM scans.

## Local Development

* Create the file `/secrets.json` with the format `{"token": }`.

* Install all the dev dependencies: `npm install`.

* Run a http server: `npm run-script test-server`.

### For testing:

#### In the browser

* Open 127.0.0.1:8080/SpecRunner.html

* To test specific files, you can use the spec parameter e.g. `127.0.0.1:8080/SpecRunner.html?spec=CodeEditor`

#### In a headless chrome instance, with coverage reports

* Run `node console_test.js`

### For viewing the editor locally:

* Open 127.0.0.1:8080/index.html

### Linting

This package is linted using tslint: `npm run-script lint`