diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 3b7b14c7f..000000000 --- a/INSTALL.md +++ /dev/null @@ -1,71 +0,0 @@ -AT Installation ---------------- - -The AT code in this repository evolved from version 1.3 of the original code -and is now maintained by the 'atcollab' collaboration, involving people from -different research institutes. - -The latest release can be found [on Github](https://github.com/atcollab/at/releases). - -Requirements: -------------- -AT is compatible with: -- **Matlab** release >= R2016b (Matlab 9.1) -- **Octave** >= 6.0 - -Installation process: ---------------------- - -1. Install git on your computer. - -2. Download the latest version of AT: - ``` - $ git clone https://github.com/atcollab/at.git - ``` - -3. Insert recursively the directories `at_installation/atmat` and -`at_installation/atintegrators` in the Matlab path. This can be done by: - - Using the GUI: - Open the "Set Path" window, press "Add with subfolders", select - `at_installation/atmat`; repeat the operation for - `at_installation/atintegrators`. - - Using the `startup.m` file: - Insert a line `addpath(genpath(at_installation/atmat)` and a similar - one for atintegrators. - - Temporarily modifying the path by running: - ``` - >> cd at_installation/atmat - >> atpath - ``` - -4. Compile all mexfunctions: - ``` - >> atmexall - ``` - -5. Update helpfiles: - ``` - >> atupdateContents - ``` - You can now use `athelp` to list all main functions. - -6. Update html doc - not yet documented. - -### Notes on Octave ### - -For the most part AT code works with [Octave](https://www.gnu.org/software/octave/). -At least version 6 is required. - -In order to prepare octave environment you'll need to run `atoctave/bootstrap.m` function. -It will install required Octave modules (Internet connection is needed), compile C sources and add -paths. - -When in `at` folder, you may start an Octave CLI session with command: -```bash -> octave --eval 'cd atoctave;bootstrap;cd ..;' --persist -``` -For GUI session, run command: -```bash -> octave --gui --eval 'cd atoctave;bootstrap;cd ..;' --persist -``` -These commands will run `atoctave/bootstrap.m` for you. diff --git a/README.md b/README.md index f78af70cb..b7986c576 100644 --- a/README.md +++ b/README.md @@ -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)