.. vasprun documentation master file

Welcome to vasprun's documentation!
===================================

VASPRUN is a library and a command-line utility for reading, analysing
and post-processing the information contained in ``vasprun.xml``
output from `VASP`_.

VASPRUN is written in Python 3 and is distributed under the `MIT
License`_

.. _`MIT license`: https://opensource.org/licenses/MIT
.. _`VASP`: https://vasp.at

.. toctree::
   :maxdepth: 1

   install
   use
   license
   contributors



Indices and tables
==================

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