py-des-lib 0.1.5
Event discrete, process based simulation for Python.
License: MIT
Requires Python: <4.0,>=3.10

<p align="center">
  <a href="" rel="noopener">
 <img src="https://github.com/vitostamatti/pydes/blob/main/docs/assets/pydes-with-bg.png?raw=true" alt="Project logo"></a>
</p>

<div align="center">

![ci](https://github.com/vitostamatti/pydes/actions/workflows/ci.yml/badge.svg)
[![pypi](https://github.com/vitostamatti/pydes/actions/workflows/pypi.yml/badge.svg)](https://github.com/vitostamatti/pydes/actions/workflows/pypi.yml)
![read-the-docs](https://readthedocs.org/projects/pydes/badge/?version=latest)

</div>

# Welcome to Py-DES

**py-des** is a Python package designed to simplify the process of discrete event simulation, providing users with an intuitive and efficient framework for modeling and analyzing complex systems. Built upon the principles of simplicity, flexibility, and performance, **py-des** aims to offer a streamlined solution for simulation tasks across various domains, including operations research, computer science, and manufacturing.

## Key Principles

- **Simplicity:** **py-des** prioritizes ease of use, allowing users to quickly define simulation models and scenarios without unnecessary complexity.

- **Flexibility:** With **py-des**, users have the flexibility to customize simulation through the usage of predefined and custom `Components`. From simple simulations to complex scenarios involving multiple entities and interactions, **py-des** adapts to diverse use cases with ease.

## Getting Started

To begin using **py-des**, simply install the package via pip (_coming soon_):

```bash
pip install py-des-lib
```

First define your main process extending the `Component` and defining a `main` method.
First define your main process extending the `Component` and defining a `main` method.

```py
from pydes import Component, Simulator

class Process(Component):
    def __init__(self, sim: Simulator):
        self.sim = sim

    def main(self):
        for _ in range(10):
            self.sim.record(self.id, "start waiting")
            self.sim.record(self.id, "start waiting")
            self.sim.sleep(2)
            self.sim.record(self.id, "end waiting")
            self.sim.record(self.id, "end waiting")
```

Now schedule the main process object and run simulation

```py
sim = Simulator()
p = Process(sim)
sim.schedule(p)
sim.run()
```

Start your journey looking at the documentation in the [quick-start](https://pydes.readthedocs.io/en/latest/quick-start/) section or check out the [examples](https://pydes.readthedocs.io/en/latest/examples/) for guidance on how to create simulation environments, schedule events, and analyze simulation outcomes.
Start your journey looking at the documentation in the [quick-start](https://pydes.readthedocs.io/en/latest/quick-start/) section or check out the [examples](https://pydes.readthedocs.io/en/latest/examples/) for guidance on how to create simulation environments, schedule events, and analyze simulation outcomes.

## Feedback and Support

If you have any questions, suggestions, or feedback regarding **py-des**, feel free to reach out via GitHub issues or the official communication channels. Your input is invaluable in shaping the future development of the library and ensuring that it meets the needs of its users.

## Todos/Ideas

- [ ] more docs
- [ ] add simulation speed
- [ ] add predefined records on components
- [ ] add components: Server, Source, Sink ...
- [ ] add a Network module with nodes and links.