.. pyjevsim documentation master file, created by
   sphinx-quickstart on Fri Sep 20 10:40:52 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyJEvSim documentation
======================

PyJEvSim is a DEVS(discrete event system specification) environment that provides journaling functionality.
It provides the ability to snapshot and restore models or simulation engines. 

  - Github Link : `PyJEvSim <https://github.com/eventsim/pyjevsim>`_


Installing PyJEvSim
-------------------
.. code-block:: console

   $ git clone https://github.com/eventsim/pyjevsim


Requirements
------------
1. python >= 3.9 
2. Pyjevsim was developed utilizing existing modules.   
   Modules are written in  “Requirements.txt” and can be installed via pip via pip.  

.. code-block:: console

   $ pip install -r requirements.txt

PyJEvSim Components :
---------------------

.. toctree::
   :maxdepth: 2

   modules

PyJEvSim Quick Start :
----------------------

.. toctree::
   :maxdepth: 1

   pyjevsim_quick_start