Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
imvs95 committed Oct 26, 2023
1 parent 6a7c266 commit b67bf0b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
16 changes: 7 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
pydsol-model : Python Distributed Simulation Object Library with Predefined Model Objects
=====================================================
==========================================================================================================

``pydsol-model`` is a package that includes standard model objects suitable for developing a discrete event simulation model. Standard model objects are source, server using resources, sink, node, link, entity and vehicle. This makes it easy and fast to design discrete event simulation models using queueing theory, useful for teaching, academic research, and commercial use. You can use the standard model objects as is, or use it to make your own objects for more complex simulation models.

**pydsol-model** is an additional layer on top of ``pydsol-core``, a Python distribution discrete event simulation library. pydsol-core uses a heap queue (priority queue) as eventlist and plans events using a relative delay instead of yield, making it much faster than most discrete event simulation packages implemented in Python. Note that you need pydsol-core (https://github.com/averbraeck/pydsol-core) to use **pydsol-model**.

This repository is currently under development at Delft University of Technology. If you would like to collaborate, please open an issue/discussion or contact `Isabelle van Schilt <https://www.tudelft.nl/staff/i.m.vanschilt/?cHash=74e749835b2a89c6c76b804683ffbbcf>`_ or `Alexander Verbraeck <https://www.tudelft.nl/staff/a.verbraeck/?cHash=79d864d800b2d588772fbe7e1778ff03>`_.

.. comment: :
To cite this repository, use https://doi.org/10.4121/22005620.
Documentation
=====================================================
Documentation for pydsol-model is available at `Read the Docs <https://pydsol-model.readthedocs.io/en/latest/index.html>`_. This includes the description of the theory behind each model object, and a step-by-step explanation of a basic and more advanced example.
Expand All @@ -18,13 +15,14 @@ Documentation for pydsol-model is available at `Read the Docs <https://pydsol-mo
Installation and set-up
=====================================================

``pydsol-model`` is available using pip install. It can be installed with the URL::
``pydsol-model`` is available using pip install.::

pip install git+https://github.com/imvs95/pydsol-model.git
pip install pydsol-model

.. comment: :
It can be installed with a SSH key::
pip install git+ssh://[email protected]/imvs95/pydsol-model.git

For the latest version, please use the URL::

pip install git+https://github.com/imvs95/pydsol-model.git


For setting up pydsol-model and ensuring that the example models can run, ``pydsol-core`` also needs to be installed. This is part of the ``requirements.txt``.
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
setup(
name="pydsol-model",
version="0.1",
description=open("README.rst").read(),
long_description=README,
long_description_content_type='text/x-rst',
author="Isabelle M. van Schilt",
url="https://github.com/imvs95/pydsol-model",
packages=["pydsol", "pydsol.model"],
Expand Down

0 comments on commit b67bf0b

Please sign in to comment.