A JSON based lattice file format
Project description
LatticeJSON
LatticeJSON is a JSON based lattice file format. JSON is able to describe complex data structures, has a human readable syntax and is available in all common programming language. It is therefore an appropriate choice to characterize the magnetic lattice of a particle accelerator.
Specification
This repository contains the Specification of LatticeJSON in form of a JSON Schema.
Example
A LatticeJSON file for a FODO lattice:
{
"version": "2.0",
"title": "FODO Lattice",
"info": "This is the simplest possible strong focusing lattice.",
"root": "RING",
"elements": {
"D1": ["Drift", {"length": 0.55}],
"Q1": ["Quadrupole", {"length": 0.2, "k1": 1.2}],
"Q2": ["Quadrupole", {"length": 0.4, "k1": -1.2}],
"B1": ["Dipole", {"length": 1.5, "angle": 0.392701, "e1": 0.1963505, "e2": 0.1963505}]
},
"lattices": {
"CELL": ["Q1", "D1", "B1", "D1", "Q2", "D1", "B1", "D1", "Q1"],
"RING": ["CELL", "CELL", "CELL", "CELL", "CELL", "CELL", "CELL", "CELL"]
}
}
LatticeJSON CLI
This repository also contains a Python based command-line tool which is able validate and convert LatticeJSON files into other common lattice file formats and vice versa.
You can install and update it using pip or pipenv:
pip install -U latticejson
Validate a LatticeJSON file:
latticejson validate /path/to/lattice.json
Convert an elegant lattice file to the LatticeJSON format:
latticejson convert --to json /path/to/lattice.lte
Autoformat one or more LatticeJSON files:
latticejson autoformat /path/to/lattice.json ...
To activate Bash completion add
eval "$(_LATTICEJSON_COMPLETE=source latticejson)"
to your .bashrc
. Or, create an activation script with:
_LATTICEJSON_COMPLETE=source latticejson > latticejson-complete.sh
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for LatticeJSON-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29bfe2fefa0a4070b42b0ac653950931a453bbd5360abf2944d7eb88323d969b |
|
MD5 | 027f2bc9daac3825aedd04af95d16032 |
|
BLAKE2b-256 | 6047338152f1fec85d7dc7a20b8c76f7469bdbbc62774f790b0453852ebb22a3 |