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

This is a copy of the main PyZgoubi respository with a few changes. https://github.com/PyZgoubi/PyZgoubi


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 3.7 or newer
* Numpy 1.16 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://pyzgoubi.org/ 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://pyzgoubi.org/ or https://github.com/PyZgoubi/PyZgoubi