Getting started
===============

Installation
------------
Wake-T is available on PyPI and can be simply installed with

.. code::

    pip install Wake-T

for more detailed instructions, including guides for installing Wake-T in HPC
clusters, check the :ref:`installation_ref` section.


.. toctree::
   :maxdepth: 2
   :hidden:

   installation


Citing Wake-T
-------------
If your usage of Wake-T leads to a scientific publication, please consider
citing the original `publication <https://dx.doi.org/10.1088/1742-6596/1350/1/012056>`_:

    A Ferran Pousa, R Assmann, A Martinez de la Ossa, Wake-T: a fast particle tracking code for plasma-based accelerators, *J. Phys.: Conf. Ser.* **1350** 012056 (2019)

Bibtex:

.. code::

    @article{FerranPousa_2019,
      doi = {10.1088/1742-6596/1350/1/012056},
      url = {https://dx.doi.org/10.1088/1742-6596/1350/1/012056},
      year = {2019},
      month = {nov},
      publisher = {IOP Publishing},
      volume = {1350},
      number = {1},
      pages = {012056},
      author = {Ferran Pousa, A and Assmann, R and Martinez de la Ossa, A},
      title = {Wake-{T}: a fast particle tracking code for plasma-based accelerators},
      journal = {Journal of Physics: Conference Series}
    }