Skip to main content

This is an application to interactively visualize MADX lattices by tweaking corresponding lattice parameters and observing the effect on lattice functions such as Beta functions or the resulting orbit.

Installation

The application can be installed from the Python Package Index (PyPI):

pip install lattice-explorer

Usage

The application can be started by invoking the installed package from the command line:

python -m lattice_explorer <path-to-madx-file>

It requires a single argument which is a file path to the MADX file containing the lattice definition.

The application then spawns two windows, one containing the lattice plots and general control elements and the other containing specific control elements for the lattice parameters (e.g. kicker and quadrupole strength). Changing a lattice parameter in the controls window, automatically updates the plots in the other window.

The plot window contains options for toggling usage of BETA0 command, or activating aperture or envelope elements in the plot orbit canvas.

The option “Freeze” copies the current plots in either the Twiss or the Orbit canvas and diplays them as dashed lines. When lattice parameters are changed now, only the continuous lines change, and the dashed lines remain to indicate the previous lattice functions which helps to compare two settings.

Customization

The application can be customized by providing various parameters, an overview of which can be obtained via

python -m lattice_explorer --help

These parameters can be provided as optional arguments like the following:

python -m lattice_explorer <path-to-madx-file> --canvas-figsize-inches 9.6 4.8

Example Screenshots

The Plots Window:

https://gitlab.com/Dominik1123/lattice-explorer/-/raw/master/screenshot_plot_window.png?inline=false

The Controls Window:

https://gitlab.com/Dominik1123/lattice-explorer/-/raw/master/screenshot_controls_window.png?inline=false

Metadata

Release files for lattice-explorer 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lattice-explorer 1.0
File Size Uploaded
lattice-explorer-1.0.tar.gz 12.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lattice-explorer 1.0
File Interpreter ABI Platform
lattice_explorer-1.0-py3-none-any.whl Python 3 none any Details

Total release size: 37.9 kB

Release files / lattice-explorer-1.0.tar.gz

Download URL lattice-explorer-1.0.tar.gz
Size 12.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1a1d4a04a2f0b6c517338d9ec55dd8682c8d6aaa4f0081b3eb60a71cead42411
BLAKE2b-256 checksum
How to use checksums
9bf542fc04c47163de93afb988f40c54cc760266cbfaae0da33364bdc02e0c20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/34.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.5.2

Release files / lattice_explorer-1.0-py3-none-any.whl

Download URL lattice_explorer-1.0-py3-none-any.whl
Size 25.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5f296e129a76666f46a8089ec3f23644e6bc78c29521e7eaa512a4ca86a0c17c
BLAKE2b-256 checksum
How to use checksums
7e885d641c18b200be7afd25412c6625f8123956d5c8214aa6e68004ecd00934
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/34.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.5.2

Release history Release notifications | RSS feed

This release

1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page