Metadata-Version: 2.0
Name: pytopplot
Version: 18.9.post3
Summary: GUI for ABCI program
Home-page: https://bitbucket.com/seregaxvm/pytopplot
Author: S.V. Matsievskiy
Author-email: matsievskiysv@gmail.com
License: GPLv3+
Keywords: wakefields accelerators particles GUI
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering :: Physics
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: numpy
Requires-Dist: PyQt5
Requires-Dist: matplotlib
Requires-Dist: PyYAML
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'

# Description

GUI for **A**zimuthal **B**eam **C**avity **I**nteraction (ABCI) program. ABCI binaries could be obtained from [http://abci.kek.jp/abci.htm](http://abci.kek.jp/abci.htm).

# Installation

## Get python and pip

Download and install python and pip.

You may use a package manager for this. For example, in Debian installation command looks like this:

`sudo apt-get install python3 python3-pip`

If you don't have a package manager, download installer from the [python web site](https://www.python.org/downloads/).

## Install *pytopplot*

From the terminal issue the command

`pip3 install pytopplot`

for system-wide installation, or

`pip3 install --user pytopplot`

for the local installation.

## Download *ABCI* binary

Download *ABCI* binary form the [*ABCI* web site](http://abci.kek.jp/abci.htm).

# Run

In order to run the program, from the terminal issue the command

`pytopplot`

If it's not found, you have modify the `PATH` environment variable to include the python scripts folder or supply the full path to the program.

When program starts, in *Settings* tab choose the location of the *ABCI* binary.

# Other

## Update *pytopplot*

To update program, from the terminal issue the command

`pip3 install --upgrade pytopplot`

for system-wide installation, or

`pip3 install --upgrade --user pytopplot`

for the local installation.

## Issue submission

In case of a problem with the program, create an issue in the [issue tracker](https://bitbucket.org/seregaxvm/pytopplot/issuesstatus=new&status=open).


