.. pyrkpp documentation main file, created by

pykpp User's Guide
===================

Python interface similar to the Kinetic Preprocessor (KPP)

The key value of `pyrkpp` is to make simple simulations easy to run in common
cloud environments like Google Colab, AWS SageMaker, Binder, or even
Jupyter-lite.

Getting Started
---------------

The best way to get started is to install (see below) and then explore the
examples gallery.


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

You can get the latest version with this command.

.. code-block::

    pip install https://github.com/barronh/pykpp/archive/main.zip


Issues
------

If you're having any problems, open an issue on github.

https://github.com/barronh/pykpp/issues


Quick Links
-----------

* :doc:`auto_examples/index`
* :doc:`api/pykpp`

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Table of Contents

   self
   auto_examples/index
   api/pykpp