Home

KENV documentation

KENV (Kapchinscky ENVelope) is a solver for the Kapchinsky-Vladimirsky envelope equation for electron beam with space charge. It is well suited for electron beam posting in an accelerator path with solenoidal and quadrupole focusing.

The distinctive feature of canvases for finding the envelope in comparison with other programs (various PIC-codes) is its speed.

Contents of the documentation

We strongly recommend that you read the Code Overview section first to have a general idea of what the code does.

Then you can see the Installation section and How to the run code to start using KENV. For more information, the API reference section lists the main objects available through KENV.

• Overview of the code
  • KENV theory
  • KENV algorithm & features
  • KENV tests
• Installation
• How to the run code
• API reference
  • The Beam class
  • The Element class
  • The Read element functions
  • The Accelerator class
  • The KapchinskyEquations class
  • The Simulation class
• Source code

Contributing to KENV

KENV is open-source, and the source code is hosted here, on Github.

We welcome contributions to the code!