Skip to content

update readme #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update readme #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down