sim-tools 0.3.2__tar.gz → 0.4.0__tar.gz

sim_tools-0.4.0/.gitignore

@@ -0,0 +1,112 @@
+# jupyter-book build folder for docs
+docs/_build/*
+
+# vscode
+.vscode/
+
+*.md.backup
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

{sim-tools-0.3.2/sim_tools.egg-info → sim_tools-0.4.0}/PKG-INFO

@@ -1,23 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: sim-tools
-Version: 0.3.2
+Version: 0.4.0
 Summary: Simulation Tools for Education and Practice
-Home-page: https://github.com/TomMonks/sim-tools
-Author: Thomas Monks
-Author-email: t.m.w.monks@exeter.ac.uk
-License: The MIT License (MIT)
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
+Project-URL: Homepage, https://github.com/TomMonks/sim-tools
+Project-URL: Bug Tracker, https://github.com/TomMonks/sim-tools/issues
+Project-URL: Documentation, https://tommonks.github.io/sim-tools
+Author-email: Thomas Monks <t.m.w.monks@exeter.ac.uk>
+License-Expression: MIT
+License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: matplotlib>=3.1.3
 Requires-Dist: numpy>=1.18.1
 Requires-Dist: pandas>=2.0.0
-Requires-Dist: scipy>=1.4.1
 Requires-Dist: scikit-learn>=1.0.0
+Requires-Dist: scipy>=1.4.1
+Description-Content-Type: text/markdown
 
 # sim-tools: tools to support the simulation process in python.
 

sim_tools-0.4.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sim-tools"
+dynamic = ["version"]
+description = "Simulation Tools for Education and Practice"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Thomas Monks", email = "t.m.w.monks@exeter.ac.uk" },
+]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+    "matplotlib>=3.1.3",
+    "numpy>=1.18.1",
+    "pandas>=2.0.0",
+    "scikit-learn>=1.0.0",
+    "scipy>=1.4.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/TomMonks/sim-tools"
+"Bug Tracker" = "https://github.com/TomMonks/sim-tools/issues"
+Documentation = "https://tommonks.github.io/sim-tools"
+
+[tool.hatch.version]
+path = "sim_tools/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/sim_tools",
+]

sim_tools-0.4.0/sim_tools/__init__.py

@@ -0,0 +1,4 @@
+__version__ = '0.4.0'
+__author__ = 'Thomas Monks'
+
+from . import datasets, distributions, time_dependent, ovs

sim_tools-0.4.0/sim_tools/data/nspp_example1.csv

@@ -0,0 +1,10 @@
+t,mean_iat
+0,15
+60,12
+120,7
+180,5
+240,8
+300,10
+360,15
+420,20
+480,20

{sim-tools-0.3.2 → sim_tools-0.4.0}/sim_tools/distributions.py

@@ -813,7 +813,13 @@ class Discrete(Distribution):
             Number of samples to return. If integer then
             numpy array returned.
         """
-        return self.rng.choice(self.values, p=self.probabilities, size=size).item()
+        sample =  self.rng.choice(self.values, p=self.probabilities, size=size)
+
+        if size is None:
+            return sample.item()
+        else:
+            return sample
+
 
 
 class TruncatedDistribution(Distribution):

sim-tools-0.3.2/PKG-INFO

@@ -1,84 +0,0 @@
-Metadata-Version: 2.1
-Name: sim-tools
-Version: 0.3.2
-Summary: Simulation Tools for Education and Practice
-Home-page: https://github.com/TomMonks/sim-tools
-Author: Thomas Monks
-Author-email: t.m.w.monks@exeter.ac.uk
-License: The MIT License (MIT)
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: matplotlib>=3.1.3
-Requires-Dist: numpy>=1.18.1
-Requires-Dist: pandas>=2.0.0
-Requires-Dist: scipy>=1.4.1
-Requires-Dist: scikit-learn>=1.0.0
-
-# sim-tools: tools to support the simulation process in python.
-
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TomMonks/sim-tools/HEAD)
-[![DOI](https://zenodo.org/badge/225608065.svg)](https://zenodo.org/badge/latestdoi/225608065)
-[![PyPI version fury.io](https://badge.fury.io/py/sim-tools.svg)](https://pypi.python.org/pypi/sim-tools/)
-[![Read the Docs](https://readthedocs.org/projects/pip/badge/?version=latest)](https://tommonks.github.io/sim-tools)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-360+/)
-[![License: MIT](https://img.shields.io/badge/ORCID-0000--0003--2631--4481-brightgreen)](https://orcid.org/0000-0003-2631-4481)
-
-sim-tools is being developed to support simulation education and applied simulation research.  It is MIT licensed and freely available to practitioners, students and researchers via PyPi.  There is a longer term plan to make sim-tools available via conda-forge.
-
- # Vision for sim-tools
-
- 1. Deliver high quality reliable code for simulation education and practice with full documentation.
- 2. Provide a simple to use pythonic interface.
- 3. To improve the quality of simulation education and encourage the use of best practice.
-
-# Features:
-
-1. Implementation of classic optimisation via Simulation procedures such as KN, KN++, OBCA and OBCA-m
-2. Distributions module that includes classes that encapsulate a random number stream, seed, and distribution parameters.
-3. Implementation of Thinning to sample from Non-stationary poisson processes in a discrete-event simulation
-
-## Three simple ways to explore sim-tools
-
-1. `pip install sim-tools`
-2. Click on the launch-binder at the top of this readme. This will open example Jupyter notebooks in the cloud via Binder.
-3. Oneline documentation: https://tommonks.github.io/sim-tools
-
-## Citation
-
-If you use sim0tools for research, a practical report, education or any reason please include the following citation.
-
-> Monks, Thomas. (2021). sim-tools: tools to support the forecasting process in python. Zenodo. http://doi.org/10.5281/zenodo.4553642
-
-```tex
-@software{sim_tools,
-  author       = {Thomas Monks},
-  title        = {sim-tools: fundamental tools to support the simulation process in python},
-  year         = {2021},
-  publisher    = {Zenodo},
-  doi          = {10.5281/zenodo.4553642},
-  url          = {http://doi.org/10.5281/zenodo.4553642}
-}
-```
-
-# Online Tutorials
-
-* Optimisation Via Simulation [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/TomMonks/sim-tools/blob/master/examples/sw21_tutorial.ipynb)
-
-
-## 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!**

sim-tools-0.3.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

sim-tools-0.3.2/setup.py

@@ -1,41 +0,0 @@
-import setuptools
-
-# patch ed - build error due to imporing numpy into __init__
-# from sim_tools import __version__
-VERSION = "0.3.2"
-
-
-# Read in the requirements.txt file
-with open("requirements.txt") as f:
-    requirements = []
-    for library in f.read().splitlines():
-        requirements.append(library)
-
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-setuptools.setup(
-    name="sim-tools",
-    version=VERSION,
-    author="Thomas Monks",
-    author_email="t.m.w.monks@exeter.ac.uk",
-    license="The MIT License (MIT)",
-    description="Simulation Tools for Education and Practice",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/TomMonks/sim-tools",
-    packages=setuptools.find_packages(),
-    #if true look in MANIFEST.in for data files to include
-    include_package_data=False,
-    #2nd approach to include data is include_package_data=False
-    #package_data={"test_package": ["data/*.csv"]},
-    #these are for documentation 
-    classifiers=[
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    python_requires='>=3.10',
-    install_requires=requirements,
-)

sim-tools-0.3.2/sim_tools/__init__.py

@@ -1,4 +0,0 @@
-__version__ = '0.3.2'
-__author__ = 'Thomas Monks'
-
-from . import datasets, distributions, time_dependent, ovs

sim-tools-0.3.2/sim_tools.egg-info/SOURCES.txt

@@ -1,20 +0,0 @@
-LICENSE
-README.md
-setup.py
-sim_tools/__init__.py
-sim_tools/datasets.py
-sim_tools/distributions.py
-sim_tools/time_dependent.py
-sim_tools.egg-info/PKG-INFO
-sim_tools.egg-info/SOURCES.txt
-sim_tools.egg-info/dependency_links.txt
-sim_tools.egg-info/requires.txt
-sim_tools.egg-info/top_level.txt
-sim_tools/ovs/__init__.py
-sim_tools/ovs/evaluation.py
-sim_tools/ovs/fixed_budget.py
-sim_tools/ovs/indifference_zone.py
-sim_tools/ovs/toy_models.py
-tests/__init__.py
-tests/test_dists.py
-tests/test_time_dep.py

sim-tools-0.3.2/sim_tools.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

sim-tools-0.3.2/sim_tools.egg-info/requires.txt

@@ -1,5 +0,0 @@
-matplotlib>=3.1.3
-numpy>=1.18.1
-pandas>=2.0.0
-scipy>=1.4.1
-scikit-learn>=1.0.0

sim-tools-0.3.2/sim_tools.egg-info/top_level.txt

@@ -1,2 +0,0 @@
-sim_tools
-tests

sim-tools-0.3.2/tests/test_dists.py

@@ -1,151 +0,0 @@
-"""
-basic smoke tests
-Create objects to check all okay
-"""
-import sim_tools.distributions as dists
-import pytest
-
-SEED_1 = 42
-
-
-def test_exponential():
-    d = dists.Exponential(10, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_lognormal():
-    d = dists.Lognormal(10, 1, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_normal():
-    d = dists.Normal(10, 1, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_uniform():
-    d = dists.Uniform(1, 10, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_tri():
-    d = dists.Triangular(1.0, 10.0, 25.0, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_bernoulli():
-    d = dists.Bernoulli(0.3, random_seed=SEED_1)
-    assert type(d.sample()) == int
-
-
-def test_fixed_type():
-    d = dists.FixedDistribution(5.0)
-    assert type(d.sample()) == float
-
-
-def test_fixed_value():
-    d = dists.FixedDistribution(5.0)
-    assert d.sample() == 5.0
-
-
-def test_combination():
-    foo = dists.Exponential(10, random_seed=SEED_1)
-    bar = dists.Normal(10, 1, random_seed=SEED_1)
-    d = dists.CombinationDistribution(foo, bar)
-    sample = d.sample()
-    assert type(sample) == float
-
-
-def test_erlang():
-    d = dists.Erlang(10.0, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_erlangk():
-    d = dists.ErlangK(1, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_gamma():
-    d = dists.Gamma(1.2, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_weibull():
-    d = dists.Weibull(1.2, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_beta():
-    d = dists.Beta(1.2, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_pearsonv():
-    d = dists.PearsonV(1.2, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_pearsonvi():
-    d = dists.PearsonVI(1.2, 1.2, 2.8, random_seed=SEED_1)
-    assert type(d.sample()) == float
-
-
-def test_poisson():
-    d = dists.Poisson(5.5, random_seed=SEED_1)
-    assert type(d.sample()) == int
-
-
-def test_continuous_empirical():
-    dist = dists.ContinuousEmpirical(
-        lower_bounds=[0, 5, 10, 15, 30, 45, 60, 120, 180, 240, 480],
-        upper_bounds=[5, 10, 15, 30, 45, 60, 120, 180, 240, 480, 2880],
-        freq=[34, 4, 8, 13, 15, 13, 19, 13, 9, 12, 73],
-        random_seed=SEED_1,
-    )
-    assert type(dist.sample()) == float
-
-
-def test_continous_empirical_length():
-    dist = dists.ContinuousEmpirical(
-        lower_bounds=[0, 5, 10, 15, 30, 45, 60, 120, 180, 240, 480],
-        upper_bounds=[5, 10, 15, 30, 45, 60, 120, 180, 240, 480, 2880],
-        freq=[34, 4, 8, 13, 15, 13, 19, 13, 9, 12, 73],
-        random_seed=SEED_1,
-    )
-    expected_size = 10
-
-    assert len(dist.sample(expected_size)) == expected_size
-
-
-def test_discrete():
-    d = dists.Discrete(values=[1, 2, 3], freq=[95, 3, 2], random_seed=SEED_1)
-    assert type(d.sample()) == int
-
-
-def test_discrete():
-    d = dists.Discrete(values=[1, 2, 3], freq=[95, 3, 2], random_seed=SEED_1)
-    assert type(d.sample()) == int
-
-
-def test_truncated_type():
-    d1 = dists.Normal(10, 1, random_seed=SEED_1)
-    d2 = dists.TruncatedDistribution(d1, lower_bound=10.0)
-    assert type(d2.sample()) == float
-
-
-@pytest.mark.parametrize(
-    "n, expected",
-    [
-        (1, 10.0),
-        (10, 10.0),
-        (100, 10.0),
-        (10_000_000, 10.0),
-        (10_000_000, 0.0),
-        (10_000_000, 0.01),
-    ],
-)
-def test_truncated_min(n, expected):
-    d1 = dists.Normal(10, 1, random_seed=SEED_1)
-    d2 = dists.TruncatedDistribution(d1, lower_bound=expected)
-    assert min(d2.sample(size=n)) >= expected

sim-tools-0.3.2/tests/test_time_dep.py

@@ -1,26 +0,0 @@
-"""
-basic tests for time dependent module
-"""
-
-import sim_tools.time_dependent as td
-from sim_tools.datasets import load_banks_et_al_nspp
-import pytest
-
-SEED_1 = 42
-SEED_2 = 101
-
-@pytest.mark.parametrize(
-    "simulation_time",
-    [
-        (0.0),
-        (10.0),
-        (55.0),
-        (10.5),
-        (2_000.00),
-        (10_000.00),
-    ],
-)
-def test_sample_from_nsppthinning(simulation_time):
-    data = load_banks_et_al_nspp()
-    d = td.NSPPThinning(data, SEED_1, SEED_2)
-    assert type(d.sample(simulation_time)) == float