Skip to main content

PyEmittance

PyEmittance is a tool for the adaptive measurement of beam emittance (e.g. of an electron beam at OTR/YAG beam profile monitors) using a single quadrupole scan developed at SLAC National Accelerator Laboratory. The Twiss parameters and the 'Bmag' match parameter can also be obtained. It can be used in different beamlines/machines by defining machine-specific configuration files.

This tool was designed for robustness during online machine learning optimizations where each measurement needs to be reliable. It is still a work in progress, with version 1.0 to be released soon.

For more information, please see the IPAC coneference proceedings DOI: 10.18429/JACoW-IPAC2022-TUPOST059

Installation

Clone the repository and run the command below to install:

pip install -e .

Or install by running:

pip install pyemittance

Setting the correct configuration parameters for the machine/simulation

For examples on how to set the correct configuration and how to use the new API, please see examples/tutorial.ipynb.

Citations

For citing this work, please use:

{@article{Miskovich:2022kqg,
    author = "Miskovich, Sara and Edelen, Auralee and Mayes, Christopher",
    title = "{PyEmittance: A General Python Package for Particle Beam Emittance Measurements with Adaptive Quadrupole Scans}",
    doi = "10.18429/JACoW-IPAC2022-TUPOST059",
    journal = "JACoW",
    volume = "IPAC2022",
    pages = "TUPOST059",
    year = "2022"
}

Metadata

Release files for pyemittance 1.1.4

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

Source distribution (sdist)

Source distribution for pyemittance 1.1.4
File Size Uploaded
pyemittance-1.1.4.tar.gz 53.6 kB Details

Release files / pyemittance-1.1.4.tar.gz

Download URL pyemittance-1.1.4.tar.gz
Size 53.6 kB
Tags Source
SHA-256 checksum
How to use checksums
62629495e46f49e72b12cbe8d348e3565f8a62f1e3d6a1813bd178a4293424f8
BLAKE2b-256 checksum
How to use checksums
8153ed0e3d2610c48a6d1c8a43c6c2d2aed0b143aa619511ce8955a3e353db13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

1.1.4 This release

1 release file

1.1.3

2 release files

1.1.2

1 release file

1.1.0

1 release file

1.0.1

1 release file

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.2.1

2 release files

0.1.1

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