Skip to content

Commit

Permalink
Python release 0.5.0 (#693)
Browse files Browse the repository at this point in the history
* New README file
  • Loading branch information
lfarv authored Nov 18, 2023
1 parent 0301367 commit dd325a4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 76 deletions.
71 changes: 0 additions & 71 deletions INSTALL.md

This file was deleted.

25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
Installation
------------

See the `INSTALL.md` document.
Accelerator Toolbox (AT) is a collection of tools to model storage rings and beam transport lines.

Online documentation
--------------------
With AT, it is possible to:

- **create and manipulate accelerator lattice elements**,
- **track particles through the lattice**, selecting the appropriate integrator to represent the physics
- **compute accelerator parameters and beam properties**, generating new scripts or taking advantage of the existing ones

AT is based on a 6-D modular tracking engine written in C/C++ for efficiency.
Lattice manipulation and computation of accelerator physics parameters are provided
by two interfaces:

- a [Matlab interface](https://atcollab.github.io/at/m/index.html), available as a Matlab toolbox,
- a [python interface](https://atcollab.github.io/at/p/index.html#), available as a python package.

## Installation

- For [Matlab](https://atcollab.github.io/at/m/Installation.html)
- For [python](https://atcollab.github.io/at/p/howto/Installation.html)

## Online documentation

- Check the [Web site](https://atcollab.github.io/at/)
- Check the [WIKI](https://github.com/atcollab/at/wiki)

0 comments on commit dd325a4

Please sign in to comment.