pyzgoubi

PyZgoubi is an interface to the Zgoubi particle tracking code written in python. It aims to ease the use of Zgoubi by providing a simple interface to create beam line elements and particles, and to automate running and analysing of simulations.

https://github.com/pyzgoubi/pyzgoubi

Repository

PyZgoubi is an interface to the Zgoubi particle tracking code written in python. It aims to ease the use of Zgoubi by providing a simple interface to create beam line elements and particles, and to automate running and analysing of simulations.

README

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 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

Citation (CITATION.cff)

cff-version: "1.1.0"

message: If you use this software, please cite it as below.

title: PyZgoubi
version: '0.7'
date-released: 2020-01-03
license: GPL-2.0-or-later
url: http://www.hep.manchester.ac.uk/u/samt/pyzgoubi/
repository-code: https://sourceforge.net/projects/pyzgoubi/
doi: 10.5281/zenodo.3597425

authors:
  - family-names: Tygier
    given-names: Sam
    email: sam.tygier@manchester.ac.uk
    orcid: https://orcid.org/0000-0002-7495-8655
  - family-names: Kelliher
    given-names: David
    email: david.kelliher@stfc.ac.uk
    orcid: https://orcid.org/0000-0001-9583-7804

references:
  - type: article
    authors:
      - family-names: Tygier
        given-names: Sam
      - family-names: Appleby
        given-names: Robert
      - family-names: Garland
        given-names: James
      - family-names: Hock
        given-names: Kai
      - family-names: Owen
        given-names: Hywel
      - family-names: Kelliher
        given-names: David
      - family-names: Sheehy
        given-names: Suzie
    title: "The PyZgoubi framework and the simulation of dynamic aperture in fixed-field alternating-gradient accelerators"
    year: 2015
    journal: "Nuclear Instruments and Methods in Physics Research Section A: Accelerators, Spectrometers, Detectors and Associated Equipment"
    volume: 775
    doi: 10.1016/j.nima.2014.11.067

GitHub Events