Virtual-IPM
Virtual-IPM is a software for simulating the electron/ion transport in Ionization Profile Monitors (IPM) and other related devices, such as Beam Induced Fluorescence Monitors (BIF). It can simulate quite general setups involving the space-charge fields from one or multiple particle beams as well as the presence of external electric/magnetic guiding fields. The application can be used from the command line but it offers a rich graphical user interface (GUI) as well.
The software has a modular structure which allows for great flexibility in terms of combining the various different realizations of beam fields, external fields, detector geometry, etc.
Use cases
The following list is a brief overview of possible use cases:
Beam profile deformation due to beam space-charge
Beam profile deformation due to guiding field non-uniformities
Gas-jet for IPM and BIF
Simulating the effect of multiple beams on electron/ion transport
Components
The following is an overview of the available implementations for the various modules:
Bunch shapes |
Bunch fields |
External fields |
Devices |
Particle generation |
|---|---|---|---|---|
Uniform |
Uniform |
Uniform |
Ionization Profile Monitor (IPM) |
Ionization via beam (IPM):
|
Gaussian |
Gaussian |
2D field maps |
Beam Induced Fluorescence Monitor (BIF) |
Excitation via beam (BIF) |
Gaussian DC |
Gaussian DC |
3D field maps |
Arbitrary CAD models (via .STL files) |
Thermal motion |
Generalized Gaussian |
Generalized Gaussian |
Thin Wire electric field |
Gas jets |
|
QGaussian |
QGaussian |
Custom CSV files |
||
Hollow DC |
Hollow DC |
|||
Parabolic Ellipsoid |
Parabolic Ellipsoid |
|||
Poisson 2D SOR |
||||
Poisson 3D |
Installation
Virtual-IPM can be installed via pip with or without GUI components. pip install Virtual-IPM[GUI] installs the application together with the graphical user interface while pip install Virtual-IPM just installs the command line version. For more information see the documentation.
Graphical User Interface
The GUI can be started via virtual-ipm-gui. At the top, it offers buttons for various functionality:
Create, save and load configuration files
Run configurations
Analyze simulation output
Command Line Usage
The application can be run from the command line via virtual-ipm path/to/config.xml. For customization and options see virtual-ipm --help.
The application also ships with a number of other command line utilities, e.g. for plotting beam fields from configuration files.
Contributing
Please contact the maintainers.
Relevant links
1 maintainer
Metadata
1 maintainer
Release files for virtual-ipm 2.3.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 | |
|---|---|---|---|
| virtual_ipm-2.3.1.tar.gz | 178.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| virtual_ipm-2.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 437.2 kB
Release files / virtual_ipm-2.3.1.tar.gz
| Download URL | virtual_ipm-2.3.1.tar.gz |
|---|---|
| Size | 178.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e6a22e866f2cdc7d78b9bdac62e91a5db2b7297fdfdc6c1765b0a49f86021f7
|
|
BLAKE2b-256 checksum How to use checksums |
c06b7d12ba8310a7150f5b0b86c5bc85579fee6efecf8c8a04934c811f93e29f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.4
|
Release files / virtual_ipm-2.3.1-py3-none-any.whl
| Download URL | virtual_ipm-2.3.1-py3-none-any.whl |
|---|---|
| Size | 258.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3ac9898930e968fcda33e19841c8d41228beb8465894a2c0e30e5f99087f10fd
|
|
BLAKE2b-256 checksum How to use checksums |
00e463b135115baa2cc2af5d2f1828dd1671129d7a0d5677beee56cafd88d7f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.4
|
