lightwin

A tool to find compensation settings for cavity failures in linear accelerators.

https://github.com/adrienplacais/lightwin

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 (15.8%) to scientific vocabulary

Keywords

compensation failure failure-compensation oop optimization particle-accelerator python3

Last synced: 6 months ago · JSON representation ·

Repository

A tool to find compensation settings for cavity failures in linear accelerators.

Basic Info

Host: GitHub
Owner: AdrienPlacais
License: mit
Language: Python
Default Branch: main
Homepage: https://lightwin.readthedocs.io/en/latest/
Size: 42.4 MB

Statistics

Stars: 0
Watchers: 1
Forks: 1
Open Issues: 1
Releases: 0

Topics

compensation failure failure-compensation oop optimization particle-accelerator python3

Created over 1 year ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Citation

README.md

LightWin

LightWin is a tool to automatically find compensation settings for cavity failures in linacs.

Installation

The full installation instructions are detailed here.

The steps are straightforward and can be summarized as follows:

Create a dedicated Python environment.
Run pip install lightwin

If you want to edit the source code:

Clone the repository: git clone git@github.com:AdrienPlacais/LightWin.git > [!WARNING] > If you Download ZIP this repository (which can happen if you don't have access to git), installation will fail at step #3. > A workaround is proposed in the documentation.
Create a dedicated Python environment.
From LightWin folder: pip install -e .[test]
Test that everything is working with pytest -m "not tracewin and not implementation".

[!NOTE] If you are completely new to Python and these instructions are unclear, check this tutorial. In particular, you will want to:

Install Python 3.12 or higher.

Learn to use Python environments, pipenv or virtualenv.

Install a Python IDE such as Spyder or VSCode.

[!NOTE] Note that the TraceWin module will not work out of the box. You will need to tell LightWin were to find your TraceWin executables. See dedicated instructions.

Documentation

Documentation is now automatically built and hosted on Read the docs.

How to run

See here.

Example

See the data/example folder.

Owner

Login: AdrienPlacais
Kind: user

Repositories: 1
Profile: https://github.com/AdrienPlacais

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it as below.
title: LightWin
abstract: A tool dedicated to finding cavity failure compensation settings in linacs.
version: 0.12.1
date-released: '2025-08-26'
authors:
- family-names: Plaçais
  given-names: Adrien
  orcid: https://orcid.org/0000-0001-6840-1685
- family-names: Bouly
  given-names: Frédéric
  orcid: https://orcid.org/0000-0002-4030-7694
- family-names: Lagniel
  given-names: Jean-Michel
- family-names: Uriot
  given-names: Didier
  orcid: https://orcid.org/0000-0003-1568-8488
- family-names: Yee-Rendon
  given-names: Bruce
  orcid: https://orcid.org/0000-0002-4589-818X
identifiers:
- description: This is the article that presented the code.
  type: doi
  value: 10.0000/nan.00000000
license: MIT
repository-code: https://github.com/AdrienPlacais/LightWin

GitHub Events

Total

Issues event: 2
Delete event: 23
Member event: 1
Push event: 194
Pull request event: 8
Fork event: 1
Create event: 58

Last Year

Issues event: 2
Delete event: 23
Member event: 1
Push event: 194
Pull request event: 8
Fork event: 1
Create event: 58

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 1
Total pull requests: 5
Average time to close issues: N/A
Average time to close pull requests: 20 days
Total issue authors: 1
Total pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 4

Past Year

Issues: 1
Pull requests: 5
Average time to close issues: N/A
Average time to close pull requests: 20 days
Issue authors: 1
Pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 4

View more stats

Top Authors

Issue Authors

AdrienPlacais (1)

Pull Request Authors

pre-commit-ci[bot] (4)
Aymeric-Tissot (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 2,187 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 15
Total maintainers: 1

pypi.org: lightwin

Automatically compensate cavity failures in linacs

Documentation: https://lightwin.readthedocs.io/
License: MIT License
Latest release: 0.12.0
published 6 months ago

Versions: 15
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 2,187 Last month

Rankings

Dependent packages count: 9.7%

Forks count: 31.9%

Average: 34.5%

Stargazers count: 41.7%

Dependent repos count: 54.6%

Maintainers (1)

AdrienP