Skip to content

Commit

Permalink
Merge pull request #30 from ax3l/fix-typos
Browse files Browse the repository at this point in the history
Fix a Few Typos, Add RTD Badge
  • Loading branch information
ax3l authored Jan 8, 2025
2 parents d83891e + 0f2e2bd commit e65f7c7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[![Documentation Status](https://readthedocs.org/projects/campa-lattice/badge/?version=latest)](https://campa-lattice.readthedocs.io)

# Accelerator Lattice Standard

An effort to create a standard to promote lattice information exchange for particle accelerators.

[Online documents.](https://campa-lattice.readthedocs.io)

## Scope

As part of this effort, we focus on the physical layout and properties of a machine.
Expand Down
2 changes: 1 addition & 1 deletion front_matter/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This excludes description of tracking of particles including collective effects.
## Participation

There are weekly (more or less) meetings to discuss development of the lattice standard.
To participate in the creation of the lattice standard, please contact [Jean-Luc Vay](https://https://github.com/jlvay) to be put on the mailing list.
To participate in the creation of the lattice standard, please contact [Jean-Luc Vay](https://github.com/jlvay) to be put on the mailing list.

## Roadmap

Expand Down
12 changes: 6 additions & 6 deletions standard/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Overview

The Accelerator Lattace Standard (ALS) defines a standard for the sharing of lattice information to describe
The Accelerator Lattice Standard (ALS) defines a standard for the sharing of lattice information to describe
particle accelerators and storage rings. ALS aims to promote:

- portability between various applications and differing algorithms
- a unified open-access description for scientific data (publishing and archiving)
- a unified open access description for scientific data (publishing and archiving)
- a unified description for post-processing, visualization and analysis.

ALS is able to describe the connections between various things
Expand All @@ -16,7 +16,7 @@ based lattice is able to
hold all the information about an entire machine complex from beam creation to dump lines enabling a
single lattice to be used as the basis of start-to-end simulations.

ALS is built to be easily customizable so that custom information may be interted by a program into a lattice.
ALS is built to be easily customizable so that custom information may be inserted by a program into a lattice.
This custom information is generally not usable by other programs but can be useful when a program accesses
lattice files that it generated.

Expand All @@ -28,7 +28,7 @@ elements into lines which beams of particles or X-rays can move through, etc.

## What ALS Is Not

ALS does not define any particular grammar to implemement the ALS schema. Rather, there are associated
ALS does not define any particular grammar to implement the ALS schema. Rather, there are associated
language specific standards that define grammars for YAML, JSON, Python, etc. Along with these
associated standards, there are packages that implement translation between lattice files and a representational
internal format defined by the package.
Expand Down Expand Up @@ -60,8 +60,8 @@ By convention, element names in ALS will be upper camel case.

A lattice **Branch** is essentially an ordered array of lattice elements that gives the physical
sequence to be tracked through.
In the simplist case, a program can track through the elements one element at a time.
However, lattice elements may overlap which will naturally complicat tracking.
In the simplest case, a program can track through the elements one element at a time.
However, lattice elements may overlap which will naturally complicate tracking.

## Lattices

Expand Down

0 comments on commit e65f7c7

Please sign in to comment.