Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 2.45 KB

README.md

File metadata and controls

30 lines (20 loc) · 2.45 KB

Georges

ci documentation Python version

Bugs Coverage Reliability Rating

License Code style: black Gitter

Georges' the lemur opinionated particle accelerator modeling Python package.

drawing

Design

Georges provides a formalism for propagating many particles through magnetic elements while considering energy degradation by implementing the Fermi-Eyges technique. Beamlines are loaded and converted using Georges-core, where support tools are also provided, notably a plotting library (entirely based on Matplotlib and Plotly). It provides plotting capabilities for various optics computations (beam envelope, Twiss parameters, ...).  Additionally, Georges includes a module for analyzing Bragg Peaks and estimating clinical properties such as R90 or lateral penumbra. It is also possible to determine the weight of each Bragg Peak in order to compute a Spread Out Bragg Peak (SOBP).

Installation

georges is available from PyPI with pip:

pip install georges

For a custom installation, please read the installation section in the documentation.