georges

Opinionated particle accelerator modeling Python package.

https://github.com/ulb-metronu/georges

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary

Keywords

accelerator beam-physics multiple-coulomb-scattering pandas physics physics-simulation physics-simulation-library
Last synced: 4 months ago · JSON representation ·

Repository

Opinionated particle accelerator modeling Python package.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 4
  • Forks: 8
  • Open Issues: 2
  • Releases: 3
Topics
accelerator beam-physics multiple-coulomb-scattering pandas physics physics-simulation physics-simulation-library
Created almost 9 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Citation Support

README.md

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.

Owner

  • Name: ULB - Métrologie Nucléaire
  • Login: ULB-Metronu
  • Kind: organization
  • Email: metronu-ap@ulb.be
  • Location: Brussels

Université libre de Bruxelles - Service de Métrologie Nucléaire

Citation (CITATION.cff)

cff-version: 1.2.0
license: GPL-3.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Hernalsteens
  given-names: Cédric
  orcid: "https://orcid.org/0000-0003-4038-6246"
- family-names: Tesse
  given-names: Robin
  orcid: "https://orcid.org/0000-0002-9617-0287"
- family-names: Gnacadja
  given-names: Eustache
  orcid: "https://orcid.org/0000-0002-3719-0771"
- family-names: Ramoisiaux
  given-names: Eliott
  orcid: "https://orcid.org/0000-0001-6523-2337"
- family-names: Vanwelde
  given-names: Marion
  orcid: "https://orcid.org/0000-0002-0339-0759"
title: "Georges"
version: 2024.1
url: "https://github.com/ULB-Metronu/georges/"

GitHub Events

Total
Last Year

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
.github/workflows/code_check.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
.github/workflows/coverage.yml actions
  • SonarSource/sonarcloud-github-action master composite
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • snok/install-poetry v1 composite
.github/workflows/deploy_doc.yml actions
  • actions/checkout v3 composite
  • actions/configure-pages v2 composite
  • actions/deploy-pages v1 composite
  • actions/setup-python v4 composite
  • actions/upload-pages-artifact v1 composite
  • snok/install-poetry v1 composite
  • ts-graphviz/setup-graphviz v1 composite
.github/workflows/docker-publish.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action ad44023a93711e3deb337508980b4b5e9bcdc5dc composite
  • docker/login-action f054a8b539a109f9f41c372932f1ae047eff08c9 composite
  • docker/metadata-action 98669ae865ea3cffbcbaa878cf57c20bbf1c6c38 composite
.github/workflows/documentation.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
Dockerfile docker
  • python 3.10 build
poetry.lock pypi
  • 243 dependencies
pyproject.toml pypi
  • georges-core 2023.2
  • hist 2.6.3
  • lmfit 1.2.2
  • pymoo 0.6.0.1
  • python >3.8.1 <3.11
  • sympy 1.12
environment.yml pypi
  • poetry *