.. pams documentation master file, created by
   sphinx-quickstart on Thu Oct 20 17:47:02 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:github_url: https://github.com/masanorihirano/pams

pams
==========================================
pams is a platform for artificial market simulations

Install:

.. code-block:: none

   pip install pams
   python
   >> import pams


.. toctree::
   :maxdepth: 1

   user_guide/index


.. toctree::
   :caption: API reference
   :maxdepth: 1

   reference/runners
   reference/simulators
   reference/sessions
   reference/markets
   reference/fundamentals
   reference/orders
   reference/events
   reference/logs
   reference/loggers
   reference/agents
   reference/utils


:ref:`genindex`

:ref:`modindex`

:ref:`search`