diff --git a/README.md b/README.md index f1c9f85..9b37b23 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # 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. +LatticeJSON is a generic lattice file format based on JSON. As different lattice files have program-specific elements and attributes a 1:1 translation between them is not always possible. A 1:1 mapping can be achieved by defining restricted versions of common latticefile formats, where only generic elements are allowed. Than lattice files in different formats can be generated from a single "ground truth" lattice file, where LatticeJSON is used as intermediate representation. + +LatticeJSON does not provide any variables or syntax to reverse or multiply sequence of elements, because it is intended to be generated by a tool. It can be thought of as a (flattened/evaluated) lattice files. + +LatticeJSON tries to provides an intermediate repres restricted versions of common lattice file formats. 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