Skip to main content

Automatically compensate cavity failures in linacs

Project description

Py versions PyPi Pytest Documentation status pre-commit.ci status License: MIT Code style: black Imports: isort

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:

  1. Create a dedicated Python environment.
  2. Run pip install lightwin

If you want to edit the source code:

  1. 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.

  1. Create a dedicated Python environment.
  2. From LightWin folder: pip install -e .[test]
  3. 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:

  1. Install Python 3.12 or higher.
  2. Learn to use Python environments, pipenv or virtualenv.
  3. 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.

Future updates

BeamCalculator

  • Beam calculator developed by JM Lagniel for SPIRAL2.
  • Envelope solvers with space-charge.

Quality of life

  • Plotter object.
  • Friendlier Evaluator.
  • Support for SET_SYNC_PHASE (see note).
  • Better handling of TraceWin errors (currently: a single error and whole run is lost).

Optimization

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lightwin-0.11.0.tar.gz (4.0 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

lightwin-0.11.0-cp313-cp313-win_amd64.whl (717.6 kB view details)

Uploaded CPython 3.13Windows x86-64

lightwin-0.11.0-cp313-cp313-musllinux_1_2_x86_64.whl (1.3 MB view details)

Uploaded CPython 3.13musllinux: musl 1.2+ x86-64

lightwin-0.11.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

lightwin-0.11.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ ARM64

lightwin-0.11.0-cp313-cp313-macosx_11_0_arm64.whl (721.9 kB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

lightwin-0.11.0-cp313-cp313-macosx_10_13_x86_64.whl (730.3 kB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

lightwin-0.11.0-cp312-cp312-win_amd64.whl (717.5 kB view details)

Uploaded CPython 3.12Windows x86-64

lightwin-0.11.0-cp312-cp312-musllinux_1_2_x86_64.whl (1.3 MB view details)

Uploaded CPython 3.12musllinux: musl 1.2+ x86-64

lightwin-0.11.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

lightwin-0.11.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ ARM64

lightwin-0.11.0-cp312-cp312-macosx_11_0_arm64.whl (722.7 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

lightwin-0.11.0-cp312-cp312-macosx_10_13_x86_64.whl (731.5 kB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

File details

Details for the file lightwin-0.11.0.tar.gz.

File metadata

  • Download URL: lightwin-0.11.0.tar.gz
  • Upload date:
  • Size: 4.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lightwin-0.11.0.tar.gz
Algorithm Hash digest
SHA256 6c13d62afe9024d8b60b5f131a4c7308bbfd69e8512b10b72c95cf22d9cac154
MD5 81c4582339cc97f9199c562e7797bc5c
BLAKE2b-256 ba9643336217df905520f294a54961ed4ad8d64516c853b66de00e3ecc0ec4d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0.tar.gz:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: lightwin-0.11.0-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 717.6 kB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lightwin-0.11.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 9c65603dce0e14c958d5b0684588a332ec6362ad5a58a5e037c38f2fd1b34b9c
MD5 d94c09c23f34ec28992345dedfaeb19b
BLAKE2b-256 10c4c9582a4151df15a1918c576e202aa974f9ec69a34c938afa821e03db8469

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp313-cp313-win_amd64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp313-cp313-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp313-cp313-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 ae41e1b8bcba93d778d52df17b14c24455c8d2bda866287ed2564f7f3300b982
MD5 fd4f826fa075deaca438c5ace6321cf4
BLAKE2b-256 581b509f39c555add3ad24bd0ef8a3e48f653cab025b8a1cde5b7c09f715447e

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp313-cp313-musllinux_1_2_x86_64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 68940f7b47e1eef300c251e9a05977e2a954b5d58177f2ed1a52ca309e9cbe92
MD5 81bdd40ff6b656d87c8d1abcaeaf9169
BLAKE2b-256 6b3aa518970591cb7c1bd0883cf1ad9b505e608baf5e588e4d04cb666d22582c

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 3bb528e1e42283a12d45da1a9f1c868b7a6d446fd7643dba05bcb5de71f94b39
MD5 3493d30c8c3236f136517f8ed4442b9b
BLAKE2b-256 a9de837155214d3e64227fa1aefacea1ac51709b084c980624fe75315d608414

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7c6521fbcbd7cfad214551a17d1bed1279617d809ed26381ec714ef709527d20
MD5 3e195ed7c18458fe61ea67cfd004a5d4
BLAKE2b-256 3cf8b191fbc429afb57c9dff8ff65287fde2110dc9443362ad452f18162b9e4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp313-cp313-macosx_11_0_arm64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp313-cp313-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 172b697d9901d94a08117b4d3386a2c209a2a66bf1b695c95972f99812fe8764
MD5 279c27517fbd3e037e8121800288a39f
BLAKE2b-256 973b31fa3c18e2cfe9c2ddcfcec266904c00d5dc25c68cebcaa48c888f645c80

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp313-cp313-macosx_10_13_x86_64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: lightwin-0.11.0-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 717.5 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lightwin-0.11.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 52315ffcd01fe36cd013c62c46790c409cc608f5c4140562b469ce68d92e9232
MD5 b76b90e5f518894c0c4c73530474b840
BLAKE2b-256 40abccbdbc8140e10dfa56ef4f48d92c915d8a5ca62cd8baf69d91f60e3c01a2

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp312-cp312-win_amd64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp312-cp312-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp312-cp312-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 467d4fc96bcb2a4f4d01a514980c2197cd89d9dd2dd0acfabd9ee511ca537f37
MD5 9bc6161d30378636d0b9752b6eb5349c
BLAKE2b-256 46cac27f370e559f2bcd54ca036db2bc44f2628e59a6a16aa319f85c99ac9a6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp312-cp312-musllinux_1_2_x86_64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3f2e7078238d41585c192f3c5fa3a07c17e7e21fcca460d78545f1d6d4f85efb
MD5 2e114bcafd83402a365439de84340c64
BLAKE2b-256 43d81a65fee4722d21e309db99b3a5c0f6f9ba369e9887bfd27ee7ee6c5c06a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 65d3fc94852373f286e3c0d26b373b464303e4520de38dbb28d2ed4784522f2e
MD5 fb7c30887c8ede49bbdeb2c96a84bd21
BLAKE2b-256 29593981cfb798df128bb8139359ea9b3e2e07892a2b1274f191b5326025c46e

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3ae450acd6d7717e2325f985f7d6588d25875d0cd7e00e987d43c162838bb7bf
MD5 2703e5b3be04bd4475eb09eae9a91009
BLAKE2b-256 22f07e3e56d3603b9fcef8e9a8ec29d2e52d98102f1528814d73a8399f40234b

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp312-cp312-macosx_11_0_arm64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightwin-0.11.0-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for lightwin-0.11.0-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 46f971563f1e337d7d3e7a149d6bd19875c03a26ea297de44310d6490b4cb481
MD5 29809e049955f5d667c42ce10b285212
BLAKE2b-256 7621a3d39bce3012b62baaa84008aacf858ad93880c2b740bbe35854c487dd5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightwin-0.11.0-cp312-cp312-macosx_10_13_x86_64.whl:

Publisher: release.yml on AdrienPlacais/LightWin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page