Merge pull request #14 from TomMonks/dev

v0.2.0

.gitignore

@@ -1,3 +1,8 @@
+# vscode
+.vscode/
+
+*.md.backup
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

CHANGES.md

@@ -0,0 +1,9 @@
+# Change log
+
+## v0.2.0
+
+* Added `sim_tools.distribution` module.  This contains classes representing popular sampling distributions for Discrete-event simulation. All classes encapsulate a `numpy.random.Generator` object, a random seed, and the parameters of a sampling distribution.  
+
+* Python has been updated, tested, and patched for 3.10 and 3.11 as well as numpy 1.20+
+
+* Minor linting and code formatting improvement.

CITATION.cff

@@ -0,0 +1,22 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: sim-tools
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: 'Thomas '
+    family-names: Monks
+    affiliation: University of Exeter
+    orcid: 'https://orcid.org/0000-0003-2631-4481'
+repository-code: 'https://github.com/TomMonks/sim-tools'
+keywords:
+  - discrete-event simulation
+  - simpy
+  - python
+  - open science
+  - simopt
+license: MIT

README.md

@@ -4,7 +4,8 @@
 [![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/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/release/python-360+/)
+[![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.
 
@@ -17,6 +18,7 @@ sim-tools is being developed to support simulation education and applied simulat
 # 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.
 
 ## Two simple ways to explore sim-tools
 
@@ -53,6 +55,6 @@ Development environment:
 
 * `conda env create -f binder/environment.yml`
 
-* `conda activate sim_tools_dev`
+* `conda activate sim_tools`
 
 **All contributions are welcome!**

binder/environment.yml

@@ -1,20 +1,14 @@
-name: sim_tools_dev
+name: sim_tools
 channels:
-  - defaults
   - conda-forge
 dependencies:
-  - jupyterlab=3.0.8
-  - matplotlib=3.1.3
-  - numpy=1.18.1
-  - pandas=1.0.1
-  - pip=20.0.2
-  - pytest=5.3.5
-  - python=3.8.1
-  - scipy=1.4.1
-  - seaborn=0.10.0
+  - matplotlib=3.8.2
+  - numpy=1.26.0
+  - pandas=2.1.3
+  - pip=23.3.1
+  - pytest=7.4.3
+  - python=3.11
+  - scipy=1.11.3
+  - scikit-learn=1.3.2
   - pip:
-    - pytest-cov==2.10.0
-    - setuptools>=51.1.2
-    - twine>=3.3.0
-    - wheel
     - sim-tools