Metadata-Version: 2.1
Name: accelerator-toolbox
Version: 0.0.2
Summary: Accelerator Toolbox
Home-page: https://pypi.org/project/accelerator-toolbox/
Author: The AT collaboration
Author-email: atcollab-general@lists.sourceforge.net
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=2.7.4
Requires-Dist: numpy (>=1.10)
Requires-Dist: scipy (>=0.16)

pyAT
====

pyAT is a Python interface to the pass methods defined in Accelerator Toolbox,
implemented by compiling the C code used in the AT 'integrators' plus a Python
extension.

It supports Python 2.7 and 3.3 to 3.6.


Installation preparation (Windows)
----------------------------------

Download Microsoft Visual C++ Compiler for Python 2.7 (`here
<https://www.microsoft.com/en-us/download/details.aspx?id=44266>`_), and use
the Visual C++ Command Prompt of the correct architecture to build pyat.

For newer versions of Python you need the appropriate version of Visual C++.


Installation (all platforms)
----------------------------

All the binaries should be built when building the Python extension.

It is easiest to do this using a virtualenv, inside pyat:

* ``virtualenv --no-site-packages venv``
* ``source venv/bin/activate  # or venv\Scripts\activate on Windows``
* ``pip install -r requirements.txt``
* ``python setup.py develop``

Finally, you should be able to run the tests:

* ``py.test test``


Comparing results with Matlab
-----------------------------

There is a second set of tests that require a Matlab licence and allows
comparing results directly with a Matlab session.  See test_matlab/README
for information.


Debugging
---------

Print statements in the C code will work once the integrators are
recompiled.  To force recompilation, remove the build directory:

* ``rm -rf build``

Any changes to .py files are automatically reinstalled in the build, but to
ensure any changes to .c files are reinstalled rerun:

* ``python setup.py develop``

If you get strange behaviour even after running setup.py develop again, then
running the following, inside pyat, should fix it:

* ``rm -rf build``
* ``find at -name "*.pyc" -exec rm '{}' \;``
* ``find at -name "*.so" -exec rm '{}' \;``
* ``python setup.py develop``

N.B. setup.py develop needs to be run with the same version of Python (and
numpy) that you are using to run pyAT.


