REDPIC documentation
======================================================

Relativistic Difference Scheme Particles-In-Cell (REDPIC)

This PIC code has been developed since 2022 as an alternative to
`ASTRA <https://www.desy.de/~mpyflo/>`_,
`WARP <https://bitbucket.org/berkeleylab/warp/>`_,
`XTRACK <https://xsuite.readthedocs.io/en/latest/>`_
and other codes.

For particle dynamics simulation using finite difference scheme relativistic.

Contents of the documentation
-----------------------------

If you are new to REDPIC, we **strongly recommend** that you read the
section :doc:`tutorial/tutorial` first, so as to have a basic understanding of
what the code does.

You can then see the section :doc:`install/installation` and
:doc:`tutorial/tutorial`, to get started with using REDPIC.

.. toctree::
  :maxdepth: 1

  theory/theory
  install/installation
  tutorial/tutorial
  test/test
  performance/performance

Contributing to REDPIC
----------------------

REDPIC is open-source, and the source code is hosted `here <http://github.com/fuodorov/redpic>`_, on
Github.

We welcome contributions to the code!

Research & Attribution
----------------------

REDPIC was developed by `Vyacheslav Fedorov <https://fuodorov.github.io>`_ and `Danila Nikiforov <mailto:nikdanila@bk.ru>`_.

REDPIC's algorithms are documented in the `manual <https://github.com/fuodorov/redpic/releases/latest>`_.