README.md

# FROM_ORBIT: calculate the tune in a fixed field accelerator from the geometry of its closed orbits

At the present, the best description of the code is what was presented at the Cyclotron'19 conference, see:
https://accelconf.web.cern.ch/cyclotrons2019/papers/frb01.pdf

## Installation
First install cyclops_wrapper following the instruction given here:
[https://gitlab.triumf.ca/beamphys/cyclops.git](https://gitlab.triumf.ca/beamphys/cyclops.git). I cannot (yet) include it as a dependency as this package is made more complicated to install by the fact that one has to compile the source code for cyclops. Don't forget to set up the environment variable `$CYCLOPS` (again see instructions for cyclops).

Install it locally using `pip`, directly from gitlab, use the following command:
```shell
pip3 install git+ssh://git@gitlab.triumf.ca/tplanche/from-orbit.git#egg=from_orbit
```
or alternatively:
```shell
pip3 install git+https://gitlab.triumf.ca/tplanche/from-orbit.git#egg=from_orbit
```
to update, re-run the command.

For local development, clone this repository and install from the local files by `cd` into this project's directory and run:
```shell
pip3 install -e .
```
to update the local version `git pull` to update the repo then re-run the `pip install` command.


In the example directory I use gnuplot to make some of the plots: you will need to install gnuplot if you want that bit to work for you. Also, to produce some of these plots, I run cyclops. I provide a linux executable under /cyclops... which may work on your system depending on library and such things. Unfortunately cyclops is not an open-source code at the moment. This is an issue that I hope to resolve soon.