.. piegy documentation master file, created by
   sphinx-quickstart on Mon Mar 31 02:03:57 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

   Add your content using ``reStructuredText`` syntax. See the 
   reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
   documentation for details.

Welcome to *piegy* documentation!
=====================================

**piegy** (/'pai-uh-gee/) is a Python package for simulating the evolutionary dynamics of two species in either 1D or 2D spatial setting.
Contains a stochastic model and analytic tools.

Full name: *Payoff-Driven Stochastic Spatial Model for Evolutionary Game Theory*

GitHub repository at: `piegy GitHub Repo <https://github.com/Chenning04/piegy.git>`_.
PyPI page: `piegy PyPI Page <https://pypi.org/project/piegy/>`_.

*Still under debugging*

To install *piegy*, run the following in terminal:

.. code-block:: bash

   pip install piegy



Overview & Clarifications
------------------------------

An overview of the contents of the ``piegy`` package and possibly confusing usages.

.. toctree::
   Overview
   Clarifications

Examples
----------------

Provides example usages, either in the minimum form or a detailed guide to all functions and class.

.. toctree::
   Usage Examples
   Typical Params


Modules
---------

Documentation of the ``piegy`` modules with examples.

.. toctree::
   piegy.simulation
   
   piegy.figures

   piegy.data_tools

   piegy.videos

   piegy.analysis

   piegy.test_var