Skip to content

Commit dd325a4

Browse files
authored
Python release 0.5.0 (#693)
* New README file
1 parent 0301367 commit dd325a4

File tree

2 files changed

+20
-76
lines changed

2 files changed

+20
-76
lines changed

INSTALL.md

Lines changed: 0 additions & 71 deletions
This file was deleted.

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
1-
Installation
2-
------------
31

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

6-
Online documentation
7-
--------------------
4+
With AT, it is possible to:
5+
6+
- **create and manipulate accelerator lattice elements**,
7+
- **track particles through the lattice**, selecting the appropriate integrator to represent the physics
8+
- **compute accelerator parameters and beam properties**, generating new scripts or taking advantage of the existing ones
9+
10+
AT is based on a 6-D modular tracking engine written in C/C++ for efficiency.
11+
Lattice manipulation and computation of accelerator physics parameters are provided
12+
by two interfaces:
13+
14+
- a [Matlab interface](https://atcollab.github.io/at/m/index.html), available as a Matlab toolbox,
15+
- a [python interface](https://atcollab.github.io/at/p/index.html#), available as a python package.
16+
17+
## Installation
18+
19+
- For [Matlab](https://atcollab.github.io/at/m/Installation.html)
20+
- For [python](https://atcollab.github.io/at/p/howto/Installation.html)
21+
22+
## Online documentation
823

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

0 commit comments

Comments
 (0)