Picht
=====

An electron optics library that uses the finite difference method (FDM) to simulate electron and ion trajectories through electric and magnetic lenses. Supports electrostatic lenses (cylindrical, einzel), magnetic lenses (permanent magnets, electromagnets) and beam sources (electron, proton, ion) in converging, diverging and parallel configurations.
Uses Neumann boundary conditions.

.. image:: https://img.shields.io/pypi/v/picht.svg 
   :target: https://pypi.org/project/picht/ 
.. image:: https://github.com/rolypolytoy/picht/actions/workflows/tests.yml/badge.svg 
   :target: https://github.com/rolypolytoy/picht/actions/workflows/tests.yml 
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg 
   :target: https://opensource.org/licenses/MIT 

Installation
-----------

To install Picht via PyPi:

.. code-block:: bash

   pip install picht

Contents
--------

.. toctree::
   :maxdepth: 2
   
   gettingstarted
   physics
   api
   auto_examples/index

Indices and tables
-----------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`