https://github.com/loiccoyle/pyaccelerator

Toy particle accelerator building blocks
https://github.com/loiccoyle/pyaccelerator

accelerator-physics

Last synced: 5 months ago
JSON representation

Toy particle accelerator building blocks

• Host: GitHub
• URL: https://github.com/loiccoyle/pyaccelerator
• Owner: loiccoyle
• License: mit
• Created: 2020-07-24T14:54:00.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-14T14:15:29.000Z (over 1 year ago)
• Last Synced: 2025-02-17T09:38:10.875Z (over 1 year ago)
• Topics: accelerator-physics
• Language: Python
• Homepage: https://pyaccelerator.readthedocs.io/
• Size: 6.97 MB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# pyaccelerator

[![Tests](https://github.com/loiccoyle/accelerator/workflows/tests/badge.svg)](https://github.com/loiccoyle/accelerator/actions?query=workflow%3Atests)

[![Documentation Status](https://readthedocs.org/projects/pyaccelerator/badge/?version=latest)](https://pyaccelerator.readthedocs.io/en/latest/?badge=latest)

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

Python package to build simple toy accelerators.

# Dependencies:

  * `numpy`

  * `matplotlib`

  * `scipy`

# Installation:

```sh

pip install pyaccelerator

```

It usualy a good idea to use a [virtual environment](https://docs.python.org/3/tutorial/venv.html). To create a virtual environment in the `venv` folder (assuming python3):

```sh

python -m venv venv

```

To activate the virtual environment:

```sh

source venv/bin/activate

```

Proceed with the installation to install in the virtual environment.

To deactivate the virtual environment:

```sh

deactivate

```

# Usage:

See the `notebooks` folder for some examples.