phenom
A phenomenological model of X-ray Free Electron Laser (XFEL) radiation.
The PHENOM python package is designed to provide a simple, robust and computationally efficient method for generating representations of the complex wavefield of X-ray Free Electron Laser pulses. By making use of approximate representations of pulse wavefront and spectra, phenom allows large ensembles of photon pulses with arbitrary statistics to be generated in a truly python-ised manner.
Getting Started
At the command line::
$ pip install phenom-xfel
To check that your instillation has worked, open iPython and try::
$ import phenom
Examples
Phenom has been designed to require minimal knowledge of the XFEL process prior to generating your first pulse.
More details on generating these pulses can be found in the documentation.
Citation:
The use of this package and the methods applied therein should be acknowledged using the following citation:
- Guest, T. W., R. Bean, R. Kammering, G. van Riessen, A. P. Mancuso, and B. Abbey. “A Phenomenological Model of the X-Ray Pulse Statistics of a High-Repetition-Rate X-Ray Free-Electron Laser.” IUCrJ 10, no. 6 (November 1, 2023). https://doi.org/10.1107/S2052252523008242.
Cited By:
Below is a list of research which have acknowledged the application of this model
- E, Juncheng, Carsten Fortmann-Grote, Trey Guest, Egor Sobolev, Luca Gelisio, Richard Bean, and Adrian P. Mancuso. “SimEx-Lite: Easy Access to Start-to-End Simulation for Experiments at Advanced Light Sources.” In Advances in Computational Methods for X-Ray Optics VI, edited by Oleg Chubar and Takashi Tanaka, 22. San Diego, United States: SPIE, 2023. https://doi.org/10.1117/12.2677299.
Metadata
Release files for phenom-xfel 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| phenom_xfel-0.1.1.tar.gz | 26.6 kB | Without provenance | Details for phenom_xfel-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| phenom_xfel-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for phenom_xfel-0.1.1-py3-none-any.whl |
Total release size: 49.3 kB
Release files / phenom_xfel-0.1.1.tar.gz
| Download URL | phenom_xfel-0.1.1.tar.gz |
|---|---|
| Size | 26.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a45115792312cedd17883577056fcd9866daf555eb68ff8d5ec94e6f0c99a1d3
|
|
BLAKE2b-256 checksum How to use checksums |
cf67595d2ea8ba7d95b557833a60980e1602eff44777b32a0e7ff80c8566b220
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.2
|
Release files / phenom_xfel-0.1.1-py3-none-any.whl
| Download URL | phenom_xfel-0.1.1-py3-none-any.whl |
|---|---|
| Size | 22.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1fd0943667ed19c205e9cf19b17cc3a3918d793c3868b39e08100eb526e5b88a
|
|
BLAKE2b-256 checksum How to use checksums |
54cc82bddb6f6d3e5ff77f8758e458ca605044050077adc49092a32d1615d104
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.2
|
Security for phenom-xfel 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.