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. PyPI page: piegy PyPI Page.

Still under debugging

To install piegy, run the following in terminal:

pip install piegy

Overview & Clarifications

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

• Overview
  • Model Design
  • Parameters
  • Runtime
• Clarifications
  • Demo Model
  • interval
  • compress_data and compress_ratio
  • Considerations regarding interval and compress_ratio
  • start and end
  • Convergence and fluc

Examples

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

• Usage Examples
• Typical Parameters
  • Parameters in Demo Model

Modules

Documentation of the piegy modules with examples.

• piegy.simulation
  • simulation.model
    • simulation.model.max_record
    • simulation.model.compress_ratio
    • simulation.model.U
    • simulation.model.V
    • simulation.model.Hpi
    • simulation.model.Dpi
    • simulation.model.copy()
    • simulation.model.clear_data()
    • simulation.model.change_maxtime()
    • simulation.model.set_seed()
    • simulation.model.compress_data()
  • simulation.run()
  • simulation.demo_model()
  • init_popu, matrices, and patch_params
  • Examples
• piegy.figures
  • Dynamics Figures
    • figures.UV_dyna()
    • figures.pi_dyna()
    • figures.UV_std()
    • figures.pi_std()
    • figures.UV_hist()
    • figures.pi_hist()
  • Distribution Figures
    • figures.UV_heatmap()
    • figures.pi_heatmap()
    • figures.UV_bar()
    • figures.pi_bar()
  • Other Functions
    • figures.UV_pi()
    • figures.UV_expected()
    • figures.UV_expected_val()
  • Examples
• piegy.data_tools
  • data_tools.save()
  • data_tools.load()
  • Examples
• piegy.videos
  • videos.SUPPORTED_FIGURES
  • videos.make_video()
  • Examples
• piegy.analysis
  • analysis.check_convergence()
  • analysis.combine_mod()
  • Examples
• piegy.test_var
  • Test Functions
    • test_var.test_var1()
    • test_var.test_var2()
  • Plot Functions
    • test_var.var_HV1()
    • test_var.var_HV2()
    • test_var.var_pi1()
    • test_var.var_pi2()
  • Other Functions
    • test_var.var_convergence1()
    • test_var.var_convergence2()
    • test_var.get_dirs1()
    • test_var.get_dirs2()
  • Examples