Introduction
============

This is an unofficial guide aimed at providing additional information not
covered by the official KPP manual. Specifically, we aim to make things more
comprehensive for the user with few or no experience running software via
command lines. We focus on the latest version of the software, release 2.2.3,
which can be freely downloaded at its `official webpage
<http://people.cs.vt.edu/~asandu/Software/Kpp/>`_. We recommend any person
reading this guide to keep a copy of the original manual since this guide is
not meant to replace it, but as a supplement to it.

In this guide our aim is to teach an inexperienced user to download, compile,
and run KPP. Furthermore, besides teaching how to run the example case in the
manual, we also instruct the user on how to modify any already-existent model
and to create new models.

The source for the documentation can be found at its `github page
<https://github.com/tomchor/ezkpp>`_ and the online html version can be
accessed `here <https://tomchor.github.io/ezkpp/>`_. You can also download this
guide in pdf `here <https://github.com/tomchor/ezkpp/raw/gh-pages/ezkpp.pdf>`_.
All of the codes and scripts created here as examples are available in the
Github repository.

The directions in this guide have been tested in as broad a range of
operational systems as was possible, but some errors are likely to arise when
applying them to other systems. If that is the case, feedback is encouraged,
either by email, in person, or by creating a Github issue in our page.

This guide was primarily typed and uploaded by Tomas Chor, but has had
substantial help from Prof. Suzanne Paulson and Dr. Paul Griffiths,
particularly for chemistry-related issues.

Contributing
------------

You can also contribute to this guide yourself. If you find the need to
correct, improve or add something, feel free to download/fork the project on
Github and modify it. We appreciate if the projects could then be merged back
after that (preferably with an updated version tag), but that is entirely up
to you. To contribute, you have to install and use `Sphinx
<http://sphinx-doc.org/>`_, which is a very handy and easy-to-use tool designed
to build multi-platform documentation effectively.

If you are not familiar with Sphinxs, you should probably read a tutorial (it's
very easy!), but a quick way to start is to download the whole thing from
Github, add some text to any file with a ``.rst`` extension and run ``make
html``. That will create a webpage (like this one) with your modifications that
you can open in your browser (open the files with a ``.html`` extension that
were created). So you can just go from there and infer the syntax from what's
already written. You can actually learn Sphinx by yourself by doing this and
might not even need to read a tutorial.