sim-tools 1.2.0__tar.gz → 1.3.0__tar.gz

{sim_tools-1.2.0 → sim_tools-1.3.0}/.gitignore

@@ -114,3 +114,12 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# Great Docs build directory (ephemeral, do not commit)
+great-docs/
+
+# Great Docs versioned-build artifacts
+_great_docs_build/
+.great-docs-build/
+.great-docs-cache/
+.great-docs/

{sim_tools-1.2.0 → sim_tools-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sim-tools
-Version: 1.2.0
+Version: 1.3.0
 Summary: Simulation Tools for Education and Practice
 Project-URL: Homepage, https://github.com/sim-tools/sim-tools
 Project-URL: Bug Tracker, https://github.com/sim-tools/sim-tools/issues
@@ -24,7 +24,7 @@ Requires-Dist: scikit-learn>=1.0.0
 Description-Content-Type: text/markdown
 
 <h1 align="center">
-  <a href="https://github.com/TomMonks/sim-tools"><img src="./docs/img/simtools_logo_purple.png" alt="Sim-tools" width="300"></a>
+  <a href="https://github.com/sim-tools/sim-tools"><img src="./assets/simtools_logo_purple.png" alt="Sim-tools" width="300"></a>
 </h1>
 
 <p align="center">
@@ -121,34 +121,4 @@ If you use sim-tools for research, a practical report, education or any reason p
 
 ## Contributing to sim-tools
 
-Please fork Dev, make your modifications, run the unit tests and submit a pull request for review.
-
-Development environment:
-
-* `conda env create -f binder/environment.yml`
-
-* `conda activate sim_tools`
-
-**All contributions are welcome!**
-
-## Tips
-
-Once in the `sim_tools` environment, you can run tests using the following command:
-
-```
-pytest
-```
-
-To view the documentation, navigate to the top level directory of the code repository in your terminal and issue the following command to build the Jupyter Book:
-
-```
-jb build docs/
-```
-
-To lint the repository, run:
-
-```
-bash lint.sh
-```
-
-NumPy style docstrings are used.
+**All contributions are welcome!** Please see `CONTRIBUTING.md` for instructions on how to contribute.

{sim_tools-1.2.0 → sim_tools-1.3.0}/README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-  <a href="https://github.com/TomMonks/sim-tools"><img src="./docs/img/simtools_logo_purple.png" alt="Sim-tools" width="300"></a>
+  <a href="https://github.com/sim-tools/sim-tools"><img src="./assets/simtools_logo_purple.png" alt="Sim-tools" width="300"></a>
 </h1>
 
 <p align="center">
@@ -96,34 +96,4 @@ If you use sim-tools for research, a practical report, education or any reason p
 
 ## Contributing to sim-tools
 
-Please fork Dev, make your modifications, run the unit tests and submit a pull request for review.
-
-Development environment:
-
-* `conda env create -f binder/environment.yml`
-
-* `conda activate sim_tools`
-
-**All contributions are welcome!**
-
-## Tips
-
-Once in the `sim_tools` environment, you can run tests using the following command:
-
-```
-pytest
-```
-
-To view the documentation, navigate to the top level directory of the code repository in your terminal and issue the following command to build the Jupyter Book:
-
-```
-jb build docs/
-```
-
-To lint the repository, run:
-
-```
-bash lint.sh
-```
-
-NumPy style docstrings are used.
+**All contributions are welcome!** Please see `CONTRIBUTING.md` for instructions on how to contribute.

{sim_tools-1.2.0 → sim_tools-1.3.0}/pyproject.toml

@@ -32,6 +32,16 @@ dependencies = [
 
 ]
 
+[dependency-groups]
+dev = [
+  "great-docs",
+  "lintquarto",
+  "pytest",
+  "ruff",
+  "simpy",
+  "treat-sim"
+]
+
 [project.urls]
 Homepage = "https://github.com/sim-tools/sim-tools"
 "Bug Tracker" = "https://github.com/sim-tools/sim-tools/issues"
@@ -47,3 +57,26 @@ include = [
 
 [[tool.hatch.envs.hatch-test.matrix]]
 python = ["3.10", "3.11", "3.12", "3.13"]
+
+[tool.ruff]
+line-length=88
+format.quote-style="double"
+lint.select = [
+    "F",    # pyflakes
+    "E",    # pycodestyle
+    "I",    # isort
+]
+lint.per-file-ignores."user_guide/*" = [
+    "F811",  # Redefinition of unused {name} from {row}
+]
+
+[tool.lintquarto]
+linters = [
+    "ruff",
+]
+paths = [
+    "user_guide",
+]
+exclude = [
+    "great-docs"
+]

sim_tools-1.3.0/sim_tools/__init__.py

@@ -0,0 +1,13 @@
+"""sim-tools"""
+
+__version__ = "1.3.0"
+
+from . import datasets, distributions, output_analysis, ovs, time_dependent
+
+__all__ = [
+    "datasets",
+    "distributions",
+    "time_dependent",
+    "ovs",
+    "output_analysis",
+]

{sim_tools-1.2.0 → sim_tools-1.3.0}/sim_tools/_validation.py

@@ -39,6 +39,7 @@ Validation functions raise appropriate exceptions with descriptive messages:
 """
 
 from typing import Any, Callable
+
 import numpy as np
 
 # Type for validator functions
@@ -48,41 +49,31 @@ ValidatorFunc = Callable[[Any, str], None]
 def is_numeric(value: Any, name: str) -> None:
     """Validates that a value is a number (int or float)."""
     if not isinstance(value, (int, float)):
-        raise TypeError(
-            f"{name} must be a number, got {type(value).__name__}"
-        )
+        raise TypeError(f"{name} must be a number, got {type(value).__name__}")
 
 
 def is_positive(value: Any, name: str) -> None:
     """Validates that a value is positive (> 0)."""
     if not value > 0:
-        raise ValueError(
-            f"{name} must be positive, got {value}"
-        )
+        raise ValueError(f"{name} must be positive, got {value}")
 
 
 def is_non_negative(value: Any, name: str) -> None:
     """Validates that a value is greater than or equal to 0."""
     if not value >= 0:
-        raise ValueError(
-            f"{name} must be greater than or equal to 0, got {value}"
-        )
+        raise ValueError(f"{name} must be greater than or equal to 0, got {value}")
 
 
 def is_probability(value: Any, name: str) -> None:
     """Validates that a value is a valid probability (between 0 and 1)."""
     if not 0 <= value <= 1:
-        raise ValueError(
-            f"{name} must be between 0 and 1, got {value}"
-        )
+        raise ValueError(f"{name} must be between 0 and 1, got {value}")
 
 
 def is_integer(value: Any, name: str) -> None:
     """Validates that a value is an integer."""
     if not isinstance(value, int):
-        raise TypeError(
-            f"{name} must be an integer, got {type(value).__name__}"
-        )
+        raise TypeError(f"{name} must be an integer, got {type(value).__name__}")
 
 
 def validate(value: Any, name: str, *validators: ValidatorFunc) -> None:
@@ -101,21 +92,22 @@ def is_ordered_pair(
         )
 
 
-# pylint: disable=too-many-arguments,too-many-positional-arguments
 def is_ordered_triplet(
-    low: Any, middle: Any, high: Any,
-    low_name: str = "low", middle_name: str = "middle", high_name: str = "high"
+    low: Any,
+    middle: Any,
+    high: Any,
+    low_name: str = "low",
+    middle_name: str = "middle",
+    high_name: str = "high",
 ) -> None:
     """Validates that three values are in ascending order."""
     if not low < middle:
         raise ValueError(
-            f"{low_name} must be less than {middle_name}, " +
-            f"got {low} >= {middle}"
+            f"{low_name} must be less than {middle_name}, " + f"got {low} >= {middle}"
         )
     if not middle < high:
         raise ValueError(
-            f"{middle_name} must be less than {high_name}, " +
-            f"got {middle} >= {high}"
+            f"{middle_name} must be less than {high_name}, " + f"got {middle} >= {high}"
         )
 
 

{sim_tools-1.2.0 → sim_tools-1.3.0}/sim_tools/datasets.py

@@ -9,13 +9,12 @@ from pathlib import Path
 
 import pandas as pd
 
-
 FILE_NAME_NSPP_1 = "nspp_example1.csv"
 PATH_NSPP_1 = Path(__file__).parent.joinpath("data", FILE_NAME_NSPP_1)
 
 
 def load_banks_et_al_nspp() -> pd.DataFrame:
-    '''
+    """
     Load example Non-stationary poisson process data from Banks et al.
 
     The function reads in the mean inter-arrival times by interval.
@@ -24,7 +23,7 @@ def load_banks_et_al_nspp() -> pd.DataFrame:
     Returns
     -------
     pandas.DataFrame
-    '''
+    """
     arrivals = pd.read_csv(PATH_NSPP_1)
-    arrivals['arrival_rate'] = 1 / arrivals['mean_iat']
+    arrivals["arrival_rate"] = 1 / arrivals["mean_iat"]
     return arrivals