Metadata-Version: 2.1
Name: accelerator-toolbox
Version: 0.2.2
Summary: Accelerator Toolbox
Home-page: https://github.com/atcollab/at
Author: The AT collaboration
Author-email: atcollab-general@lists.sourceforge.net
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6.0
Requires-Dist: scipy (>=0.16)
Requires-Dist: numpy (>=1.16.6) ; python_version < "3.10"
Requires-Dist: importlib-metadata ; python_version < "3.8"
Requires-Dist: numpy (>=1.21.5) ; python_version >= "3.10"
Provides-Extra: dev
Requires-Dist: pytest (>=2.9) ; extra == 'dev'
Requires-Dist: pytest-lazy-fixture ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'

pyAT
====

Introduction
------------

Accelerator Toolbox is a code used for simulating particle accelerators, used
particularly for synchrotron light sources. It is hosted on `Github
<https://github.com/atcollab>`_. Its original implementation is in Matlab.

pyAT is a Python interface to Accelerator Toolbox. It uses the 'pass methods'
defined in Accelerator Toolbox, implemented by compiling the C code used in the
AT 'integrators' into a Python extension. These pass methods are used by
higher-level functions to provide physics results.

See the `pyAT website <https://atcollab.github.io/at/python.html>`_ for a
more detailed introduction.

pyAT supports Python 3.6 to 3.9.

Installation
------------

Install accelerator-toolbox from PyPI::

    pip install accelerator-toolbox

Usage
-----

Example usage::

    >>> from at.load import load_mat
    >>> from at.physics import get_optics
    >>> ring = load_mat('test_matlab/hmba.mat')
    >>> get_optics(ring, refpts=range(5))

For more examples of how to use pyAT, see ``pyat_examples.rst``.

Developer Notes
---------------

Developer notes are in ``developers.rst``.



