Metadata-Version: 2.1
Name: de-sim
Version: 0.0.2
Summary: Python framework for discrete event simulation
Home-page: https://github.com/KarrLab/de_sim
Author: Karr Lab
Author-email: info@karrlab.org
License: MIT
Download-URL: https://github.com/KarrLab/de_sim
Keywords: discrete event simulation DES Python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: configobj
Requires-Dist: logging2
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: progressbar2 (>=3.39)
Requires-Dist: pympler
Requires-Dist: setuptools
Requires-Dist: wc-utils[git]
Provides-Extra: all
Requires-Dist: sphinx (>=1.8) ; extra == 'all'
Requires-Dist: sphinx-fontawesome ; extra == 'all'
Requires-Dist: sphinx-rtd-theme (>=0.4.2) ; extra == 'all'
Requires-Dist: sphinxcontrib-addmetahtml (>=0.1.1) ; extra == 'all'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'all'
Requires-Dist: sphinxcontrib-googleanalytics (>=0.1.1) ; extra == 'all'
Requires-Dist: sphinxcontrib-spelling ; extra == 'all'
Requires-Dist: sphinxprettysearchresults ; extra == 'all'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.8) ; extra == 'docs'
Requires-Dist: sphinx-fontawesome ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (>=0.4.2) ; extra == 'docs'
Requires-Dist: sphinxcontrib-addmetahtml (>=0.1.1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Requires-Dist: sphinxcontrib-googleanalytics (>=0.1.1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-spelling ; extra == 'docs'
Requires-Dist: sphinxprettysearchresults ; extra == 'docs'
Provides-Extra: tests

|Documentation| |Test results| |Test coverage| |Code analysis| |License|
|Analytics|

DE-Sim
======

``DE-Sim`` provides an object-oriented discrete event simulation tool
for Python that's similar to Simula. Simulation logical processes are
objects and they schedule simulation events by exchanging messages.
Simulation applications are composed of multiple subclasses of
``SimulationObject``.

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

1. Install dependencies

   -  Python >= 3.7
   -  pip >= 19

2. Install this package

   -  Install latest release from PyPI ``de_sim``

   -  Install latest revision from GitHub
      ``pip install git+https://github.com/KarrLab/de_sim.git#egg=de_sim``

API documentation
-----------------

Please see the `API documentation <https://docs.karrlab.org/de_sim>`__.

License
-------

The package is released under the `MIT license <LICENSE>`__.

Contributing to ``DE-Sim``
--------------------------

We enthusiastically welcome contributions to ``DE-Sim``! Please see the
`guide to contributing <CONTRIBUTING.md>`__ and the `developer's code of
conduct <CODE_OF_CONDUCT.md>`__.

Development team
----------------

This package was developed by the `Karr Lab <https://www.karrlab.org>`__
at the Icahn School of Medicine at Mount Sinai in New York, USA by the
following individuals:

-  `Arthur
   Goldberg <https://www.mountsinai.org/profiles/arthur-p-goldberg>`__
-  `Jonathan Karr <https://www.karrlab.org>`__

Acknowledgements
----------------

This work was supported by National Science Foundation award 1649014 and
National Institutes of Health award R35GM119771.

Questions and comments
----------------------

Please submit questions and issues to
`GitHub <https://github.com/KarrLab/de_sim/issues>`__ or contact the
`Karr Lab <mailto:info@karrlab.org>`__.

.. |Documentation| image:: https://readthedocs.org/projects/de_sim/badge/?version=latest
   :target: https://docs.karrlab.org/de_sim
.. |Test results| image:: https://circleci.com/gh/KarrLab/de_sim.svg?style=shield
   :target: https://circleci.com/gh/KarrLab/de_sim
.. |Test coverage| image:: https://coveralls.io/repos/github/KarrLab/de_sim/badge.svg
   :target: https://coveralls.io/github/KarrLab/de_sim
.. |Code analysis| image:: https://api.codeclimate.com/v1/badges/2fa3ece22f571fd36b12/maintainability
   :target: https://codeclimate.com/github/KarrLab/de_sim
.. |License| image:: https://img.shields.io/github/license/KarrLab/de_sim.svg
   :target: LICENSE
.. |Analytics| image:: https://ga-beacon.appspot.com/UA-86759801-1/de_sim/README.md?pixel



