https://github.com/felix-andreas/apace

Another Particle Accelerator Code
https://github.com/felix-andreas/apace

accelerator-physics python

Last synced: 4 months ago
JSON representation

Another Particle Accelerator Code

• Host: GitHub
• URL: https://github.com/felix-andreas/apace
• Owner: felix-andreas
• License: gpl-3.0
• Created: 2018-09-03T18:10:16.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2021-12-20T23:33:52.000Z (about 3 years ago)
• Last Synced: 2024-10-25T09:27:00.329Z (4 months ago)
• Topics: accelerator-physics, python
• Language: Python
• Homepage: https://apace.readthedocs.io
• Size: 1.41 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# apace

[![Python Version](https://img.shields.io/pypi/pyversions/apace)](https://pypi.org/project/apace/)

[![PyPI](https://img.shields.io/pypi/v/apace.svg)](https://pypi.org/project/apace/)

[![CI](https://github.com/andreasfelix/apace/workflows/CI/badge.svg)](https://github.com/andreasfelix/apace/actions?query=workflow%3ACI)

[![Docs](https://readthedocs.org/projects/apace/badge/?version=latest)](https://apace.readthedocs.io)

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/andreasfelix/apace/blob/master/LICENSE)

**apace** is yet **a**nother **p**article **a**ccelerator **c**od**e** designed for the optimization of beam optics. It is available as Python package and aims to provide a convenient and straightforward API to make use of Python's numerous scientific libraries.

## Installing

Install and update using pip:

```sh

pip install -U apace

```

## Requirements

- Python 3.6 or higher (CPython or PyPy)

- CFFI 1.0.0 or higher

- NumPy/SciPy

- Matplotlib

## Quick Start

Import apace:

```python

import apace as ap

```

Create a ring consisting out of 8 FODO cells:

```python

d1 = ap.Drift('D1', length=0.55)

b1 = ap.Dipole('B1', length=1.5, angle=0.392701, e1=0.1963505, e2=0.1963505)

q1 = ap.Quadrupole('Q1', length=0.2, k1=1.2)

q2 = ap.Quadrupole('Q2', length=0.4, k1=-1.2)

fodo_cell = ap.Lattice('FODO', [q1, d1, b1, d1, q2, d1, b1, d1, q1])

fodo_ring = ap.Lattice('RING', [fodo_cell] * 8)

```

 

Calculate the Twiss parameters:

```python

twiss = ap.Twiss(fodo_ring)

```

Plot horizontal and vertical beta functions using matplotlib:

```python

import matplotlib.pyplot as plt

plt.plot(twiss.s, twiss.beta_x, twiss.s, twiss.beta_y)

```

## Links

- Documentation: https://apace.readthedocs.io

- API Reference: https://apace.readthedocs.io/en/stable/reference/apace/index.html

- Examples: https://apace.readthedocs.io/en/docs/examples/index.html

- Releases: https://pypi.org/project/apace/

- Code: https://github.com/andreasfelix/apace

- Issue tracker: https://github.com/andreasfelix/apace/issues

## License

[GNU General Public License v3.0](https://github.com/andreasfelix/apace/blob/master/LICENSE)