salabim 24.0.9__tar.gz → 24.0.10__tar.gz

{salabim-24.0.9 → salabim-24.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: salabim
-Version: 24.0.9
+Version: 24.0.10
 Summary: salabim - discrete event simulation in Python
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://salabim.org

{salabim-24.0.9 → salabim-24.0.10}/README.md

@@ -1,64 +1,64 @@
- <img src="https://www.salabim.org/salabim_logo_payoff.png" width=400 />
-
-Salabim is a Python library for object-oriented discrete event simulation (DES) and animation.
-
-### Introduction
-
-Discrete event simulation (DES) finds applications in various logistical domains including production facilities, warehousing, airports, hospitals, mining, materials handling, steel mills, and computer network analysis.
-
-Salabim follows a well-proven and intuitive process description method similar to Tomas and Must.</br>The package provides:
-
-- Components
-- Queues
-- Resources
-- Stores
-- States
-- Monitors for data collection and presentation
-- 2D and 3D animation (including video production) (see below)
-- Tracing facilities
-- Advanced statistical sampling
-
-In contrast to some other Python DES packages, salabim does not require the use of yield statements for process control, making it more straightforward to use. Salabim has minimal requirements, especially when animation is disabled.
-
-
-
-### Some salabim animations
-
- <img src="https://www.salabim.org/cymulation3d.gif" width=700 />
-
- <img src="https://www.salabim.org/elevator.gif" width=700 />
-
- <img src="https://www.salabim.org/lights-3d.gif" width=700 />
-
-### Features and documentation
-
-- Cross-platform support: salabim runs on Windows, macOS, Linux, iOS/iPadOS (Pythonista), and can even be used with "Python In Excel".
-- Comprehensive documentation: Visit [www.salabim.org/manual](www.salabim.org/manual) for detailed documentation.
-
-### Resources
-
-The salabim package can be found on GitHub: www.github.com/salabim/salabim
-
-And on PyPI: https://pypi.org/project/salabim/
-
-### Contributing and Reporting Issues
-
-Contributions to salabim are highly appreciated! You can contribute by issuing a pull request or submitting an issue on [GitHub](https://github.com/salabim/salabim). Alternatively, you can use the [salabim Google user group](https://groups.google.com/g/salabim) for discussions and reporting issues.
-
-### License
-
-Salabim is licensed under the MIT License. For details, please refer to the [LICENSE](LICENSE) file.
-
-### Support
-
-Ruud van der Ham, the core developer, is available and willing to help users with issues related to the package and modeling in general. He also provides services such as code and model reviews, consultancy, and training.
-
-### Getting Started
-
-To start using salabim, visit [www.salabim.org](www.salabim.org) for installation instructions and further details.
-
-### Badges
-
-![PyPI](https://img.shields.io/pypi/v/salabim) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/salabim) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/salabim)
-![PyPI - License](https://img.shields.io/pypi/l/salabim) ![Black](https://img.shields.io/badge/code%20style-black-000000.svg) 
-![GitHub last commit](https://img.shields.io/github/last-commit/salabim/salabim)
+ <img src="https://www.salabim.org/salabim_logo_payoff.png" width=400 />
+
+Salabim is a Python library for object-oriented discrete event simulation (DES) and animation.
+
+### Introduction
+
+Discrete event simulation (DES) finds applications in various logistical domains including production facilities, warehousing, airports, hospitals, mining, materials handling, steel mills, and computer network analysis.
+
+Salabim follows a well-proven and intuitive process description method similar to Tomas and Must.</br>The package provides:
+
+- Components
+- Queues
+- Resources
+- Stores
+- States
+- Monitors for data collection and presentation
+- 2D and 3D animation (including video production) (see below)
+- Tracing facilities
+- Advanced statistical sampling
+
+In contrast to some other Python DES packages, salabim does not require the use of yield statements for process control, making it more straightforward to use. Salabim has minimal requirements, especially when animation is disabled.
+
+
+
+### Some salabim animations
+
+ <img src="https://www.salabim.org/cymulation3d.gif" width=700 />
+
+ <img src="https://www.salabim.org/elevator.gif" width=700 />
+
+ <img src="https://www.salabim.org/lights-3d.gif" width=700 />
+
+### Features and documentation
+
+- Cross-platform support: salabim runs on Windows, macOS, Linux, iOS/iPadOS (Pythonista), and can even be used with "Python In Excel".
+- Comprehensive documentation: Visit [www.salabim.org/manual](www.salabim.org/manual) for detailed documentation.
+
+### Resources
+
+The salabim package can be found on GitHub: www.github.com/salabim/salabim
+
+And on PyPI: https://pypi.org/project/salabim/
+
+### Contributing and Reporting Issues
+
+Contributions to salabim are highly appreciated! You can contribute by issuing a pull request or submitting an issue on [GitHub](https://github.com/salabim/salabim). Alternatively, you can use the [salabim Google user group](https://groups.google.com/g/salabim) for discussions and reporting issues.
+
+### License
+
+Salabim is licensed under the MIT License. For details, please refer to the [LICENSE](LICENSE) file.
+
+### Support
+
+Ruud van der Ham, the core developer, is available and willing to help users with issues related to the package and modeling in general. He also provides services such as code and model reviews, consultancy, and training.
+
+### Getting Started
+
+To start using salabim, visit [www.salabim.org](www.salabim.org) for installation instructions and further details.
+
+### Badges
+
+![PyPI](https://img.shields.io/pypi/v/salabim) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/salabim) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/salabim)
+![PyPI - License](https://img.shields.io/pypi/l/salabim) ![Black](https://img.shields.io/badge/code%20style-black-000000.svg) 
+![GitHub last commit](https://img.shields.io/github/last-commit/salabim/salabim)

{salabim-24.0.9 → salabim-24.0.10}/pyproject.toml

@@ -8,7 +8,7 @@ authors = [
     {name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com"}
 ]
 description = "salabim - discrete event simulation in Python"
-version = "24.0.9"
+version = "24.0.10"
 readme = "README.md"
 requires-python = ">=3.7"
 dependencies = [

{salabim-24.0.9 → salabim-24.0.10}/salabim/salabim.py

@@ -1,13 +1,13 @@
-#               _         _      _               ____   _  _        ___       ___
-#   ___   __ _ | |  __ _ | |__  (_) _ __ ___    |___ \ | || |      / _ \     / _ \
-#  / __| / _` || | / _` || '_ \ | || '_ ` _ \     __) || || |_    | | | |   | (_) |
-#  \__ \| (_| || || (_| || |_) || || | | | | |   / __/ |__   _| _ | |_| | _  \__, |
-#  |___/ \__,_||_| \__,_||_.__/ |_||_| |_| |_|  |_____|   |_|  (_) \___/ (_)   /_/
+#               _         _      _               ____   _  _        ___      _   ___
+#   ___   __ _ | |  __ _ | |__  (_) _ __ ___    |___ \ | || |      / _ \    / | / _ \
+#  / __| / _` || | / _` || '_ \ | || '_ ` _ \     __) || || |_    | | | |   | || | | |
+#  \__ \| (_| || || (_| || |_) || || | | | | |   / __/ |__   _| _ | |_| | _ | || |_| |
+#  |___/ \__,_||_| \__,_||_.__/ |_||_| |_| |_|  |_____|   |_|  (_) \___/ (_)|_| \___/
 #                    discrete event simulation
 #
 #  see www.salabim.org for more information, the documentation and license information
 
-__version__ = "24.0.9"
+__version__ = "24.0.10"
 
 import heapq
 import random
@@ -445,10 +445,8 @@ class Monitor:
         *args,
         **kwargs,
     ):
-        if env is None:
-            self.env = g.default_env
-        else:
-            self.env = env
+        self.env = _set_env(env)
+
         if isinstance(self.env, Environment):
             _set_name(name, self.env._nameserializeMonitor, self)
         else:
@@ -855,8 +853,10 @@ class Monitor:
             else:
                 stop += self.env._offset
                 stop_action = "b"  # non inclusive
-
-            stop = min(stop, self.env._now - self.env._offset)  # not self.now() in order to support frozen monitors
+            if self.env._animate:
+                stop=min(stop,self.env._t)
+            else:
+                stop = min(stop, self.env._now - self.env._offset)  # not self.now() in order to support frozen monitors
             actions.append((start, "a", 0, 0))
             actions.append((stop, stop_action, 0, 0))
         else:
@@ -888,8 +888,33 @@ class Monitor:
             new._x.append(curx)
 
         enabled = False
+        if self.env._animate:
+            _x=self._x[:]
+            _t=self._t[:]
+            if self._x:
+                _x.append(self._x[-1])
+                _t.append(self.env._t)
+            if isinstance(self._weight,bool):
+                _weight=self._weight
+            else:
+                _weight=self._weight[:]
+                _weight.append(self._weight[-1])
+        else:
+            _x=self._x
+            _t=self._t
+            _weight=self._weight
+
+
+        if self.env._animate:
+            if self._x:
+                _x.append(_x[-1])
+                _t.append(self.env._t)
+            try:
+                _weight.append(self.weight[-1])
+            except AttributeError:
+                ... # ignore if bool
         for t, type, x, weight in heapq.merge(
-            actions, zip(self._t, itertools.repeat("c"), self._x, self._weight if (self._weight and not self._level) else (1,) * len(self._x))
+            actions, zip(self._t, itertools.repeat("c"), _x, _weight if (_weight and not self._level) else (1,) * len(_x))
         ):
             if new._level:
                 if type == "a":
@@ -3472,6 +3497,9 @@ class DynamicClass:
         if callable(c):
             if inspect.isfunction(c):
                 nargs = c.__code__.co_argcount
+                if c.__defaults__ is not None:
+                    c.__defaults__ = tuple(self if x == object else x for x in c.__defaults__)  # indicate that object refers to animation object itself
+                    nargs -= len(c.__defaults__)
                 if nargs == 0:
                     return c()
                 if nargs == 1:
@@ -4290,10 +4318,8 @@ class Queue:
     """
 
     def __init__(self, name: str = None, monitor: Any = True, fill: Iterable = None, capacity: float = inf, env: "Environment" = None, *args, **kwargs) -> None:
-        if env is None:
-            self.env = g.default_env
-        else:
-            self.env = env
+        self.env = _set_env(env)
+
         _set_name(name, self.env._nameserializeQueue, self)
         self._head = Qmember()
         self._tail = Qmember()
@@ -5816,7 +5842,8 @@ class Animate3dBase(DynamicClass):
         self, visible: bool = True, keep: bool = True, arg: Any = None, layer: float = 0, parent: "Component" = None, env: "Environment" = None, **kwargs
     ) -> None:
         super().__init__()
-        self.env = g.default_env if env is None else env
+        self.env = _set_env(env)
+
         self.visible = visible
         self.keep = keep
         self.arg = self if arg is None else arg
@@ -7060,10 +7087,8 @@ class Component:
         env: "Environment" = None,
         **kwargs,
     ):
-        if env is None:
-            self.env = g.default_env
-        else:
-            self.env = env
+        self.env = _set_env(env)
+
         _set_name(name, self.env._nameserializeComponent, self)
         self._qmembers = {}
         self._process = None
@@ -14101,7 +14126,7 @@ class Environment:
 
         also the legend for line numbers will be printed
 
-        not that the header is only printed if trace=True
+        note that the header is only printed if trace=True
         """
         len_s1 = len(self.time_to_str(0))
         self.print_trace((len_s1 - 4) * " " + "time", "current component", "action", "information", "" if PythonInExcel else "line#")
@@ -14670,7 +14695,7 @@ class Environment:
         if self._last_animate != self._animate or self._last_paused != self._paused:
             for key in self._ui_window.key_dict:
                 field = self._ui_window[key]
-                if type(field) != sg.PySimpleGUI.HorizontalSeparator:
+                if type(field) != sg.HorizontalSeparator:
                     if self._paused:
                         field.update(visible=True)
                     else:
@@ -14847,9 +14872,10 @@ class Animate2dBase(DynamicClass):
         screen_coordinates = locals_["screen_coordinates"]
         over3d = locals_["over3d"]
 
-        self.env = g.default_env if env is None else env
+        self.env = _set_env(env)
+
         self.sequence = self.env.serialize()
-        self.arg = self if arg is None else arg
+        self.arg = self if arg in (None, object) else arg
         self.over3d = _default_over3d if over3d is None else over3d
         self.screen_coordinates = screen_coordinates
         self.attached_to = attached_to
@@ -15927,7 +15953,8 @@ class Animate:
         animation_to: float = inf,
         env: "Environment" = None,
     ):
-        self.env = g.default_env if env is None else env
+        self.env = _set_env(env)
+
         self._image_ident = None  # denotes no image yet
         self._image = None
         self._image_x = 0
@@ -17049,7 +17076,8 @@ class AnimateEntry:
         env: "Environment" = None,
         xy_anchor: str = "sw",
     ):
-        self.env = g.default_env if env is None else env
+        self.env = _set_env(env)
+
         self.env.ui_objects.append(self)
         self.type = "entry"
         self.value = value
@@ -17194,7 +17222,8 @@ class AnimateButton:
         env: "Environment" = None,
         xy_anchor: str = "sw",
     ):
-        self.env = g.default_env if env is None else env
+        self.env = _set_env(env)
+
         self.type = "button"
         self.t0 = -inf
         self.t1 = inf
@@ -17375,7 +17404,7 @@ class AnimateSlider:
         labelcolor: ColorType = None,  # only for backward compatibility
         layer: float = None,  # only for backward compatibility
     ):
-        self.env = g.default_env if env is None else env
+        self.env = _set_env(env)
         n = round((vmax - vmin) / resolution) + 1
         self.vmin = vmin
         self.vmax = vmin + (n - 1) * resolution
@@ -22637,10 +22666,7 @@ class State:
     """
 
     def __init__(self, name: str = None, value: Any = False, type: str = "any", monitor: bool = True, env: "Environment" = None, *args, **kwargs):
-        if env is None:
-            self.env = g.default_env
-        else:
-            self.env = env
+        self.env = _set_env(env)
         _set_name(name, self.env._nameserializeState, self)
         self._value = value
         with self.env.suppress_trace():
@@ -23115,11 +23141,7 @@ class Resource:
         *args,
         **kwargs,
     ):
-        if env is None:
-            self.env = g.default_env
-        else:
-            self.env = env
-
+        self.env = _set_env(env)
         if initial_claimed_quantity != 0:
             if not anonymous:
                 raise ValueError("initial_claimed_quantity != 0 only allowed for anonymous resources")
@@ -23648,10 +23670,8 @@ class PeriodMonitor:
 
     def __init__(self, parent_monitor: "Monitor", periods: Iterable = None, period_monitor_names: Iterable = None, env: "Environment" = None):
         self.pc = _PeriodComponent(pm=self, skip_standby=True, suppress_trace=True)
-        if env is None:
-            self.env = g.default_env
-        else:
-            self.env = env
+        self.env = _set_env(env)
+
         if periods is None:
             periods = 24 * [1]
         self.periods = periods
@@ -26928,6 +26948,21 @@ def reset() -> None:
     random_seed()  # always start with seed 1234567
 
 
+def _set_env(env):
+    """
+    returns g._default_env if env is None
+    returns env, otherwise
+
+    will raise a ValueError if g.default_env is None (nit initialized)
+    """
+
+    if env is None:
+        if g.default_env is None:
+            raise ValueError("no default environment. Did yout forget to call sim.Environment()?")
+        return g.default_env
+    return env
+
+
 App = Environment
 
 

{salabim-24.0.9 → salabim-24.0.10}/salabim.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: salabim
-Version: 24.0.9
+Version: 24.0.10
 Summary: salabim - discrete event simulation in Python
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://salabim.org