File	Date	Author	Commit
defs	2019-09-17	davidkelliher	[b6a0b0] Add MAP2D element
devtools	2014-04-03	Sam Tygier	[0846f1] labplot: allow custom styles
doc	2019-07-15	Sam Tygier	[029a4d] Prepare for 0.7.0b1
examples	2014-08-29	davidkelliher	[c24679] in get_twiss_profiles, interpolate onto azimuth...
tests	2019-10-29	Sam Tygier	[f3cdb3] Fix tests with Numpy 1.16
zgoubi	2020-01-29	Sam Tygier	[20f8bd] Remove in_bounds, check_bounds, get_extremes, l...
.bzrignore	2010-01-27	Sam Tygier	[5c2dc6] update zgoubi/version.py from setup.py, output ...
.gitignore	2018-01-11	Sam Tygier	[73ccbc] Ignore some files that don't need to be in git
AUTHORS	2016-09-02	Sam Tygier	[3e6ceb] Update files for 0.6 release
CHANGES	2020-01-29	Sam Tygier	[20f8bd] Remove in_bounds, check_bounds, get_extremes, l...
CITATION.cff	2020-01-03	Sam Tygier	[8be1ee] Start developement for 0.8
COPYING	2009-03-03	Sam Tygier	[b06af3] Initial import:pyzgoubi 0.2.3
MANIFEST.in	2020-01-03	Sam Tygier	[8be1ee] Start developement for 0.8
README	2020-01-03	Sam Tygier	[8be1ee] Start developement for 0.8
pylintrc	2010-05-25	Sam Tygier	[f87e33] pylint fixes in pyzgoubi
pyzgoubi	2019-07-15	Sam Tygier	[029a4d] Prepare for 0.7.0b1
run_tests.py	2016-09-02	Sam Tygier	[51a98c] Migrate from distutils to setuptools. Mostly re...
setup.cfg	2016-09-02	Sam Tygier	[51a98c] Migrate from distutils to setuptools. Mostly re...
setup.py	2020-01-03	Sam Tygier	[8be1ee] Start developement for 0.8

Read Me

Python Zgoubi
=============

https://doi.org/10.5281/zenodo.3597425


This is an interface to zgoubi. And framework for accelerator design. It is tested with zgoubi 6.0.1 from http://sourceforge.net/projects/zgoubi/ as well as recent developement versions, on Linux, MacOS X and Windows.

Requirements:

* Python 2.5 or newer (not ported to 3.x yet)(2.7 recommended)
* Numpy 1.4 or newer 

Recomended

* Scipy
* Matplotlib

Some features may require the new versions

Zgoubi can require several GB of RAM. See the Memory Issues section in the documentation for hints for low RAM systems.


To install run::

	./setup.py install

or to in install to a specific place::

	./setup.py install --prefix=/home/sam/pyzgoubi

If you install pyzgoubi to a custom prefix you may need to adjust your $PATH and $PYTHONPATH variables, the install script will give you some hints about what to do.

Once pyzgoubi is install run::

	pyzgoubi --version

to check that it runs correctly. You may need to do this from a new terminal in order be using an updated $PATH. Don't run this from the inside the source directory.

To automatically install zgoubi run::

	pyzgoubi --install-zgoubi

this installs zgoubi into ~/.pyzgoubi/bin you can adjust ~/.pyzgoubi/settings.ini to use this as the default zgoubi executable.

There are some tests distributed with the source code. To run tests run::

	./run_tests

Note that there are some know failures, see CHANGES for more info. 

Documentation is available at http://www.hep.manchester.ac.uk/u/samt/pyzgoubi/doc.html or in the doc/ directory.
To build the documentation run (you will need sphinx installed)::

	./setup.py build_sphinx

More information can be found at http://www.hep.manchester.ac.uk/u/samt/pyzgoubi/ or https://sourceforge.net/projects/pyzgoubi/