replications-algorithm

An implementation of the Replications Algorithm to automatically select the no. of replications in a DES

https://github.com/theopensciencenerd/replications-algorithm

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

An implementation of the Replications Algorithm to automatically select the no. of replications in a DES

Basic Info
  • Host: GitHub
  • Owner: TheOpenScienceNerd
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 19.3 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

ORCID: Monks License: MIT

The replications algorithm for Discrete-Event Simulation

The materials in this repo provide a Python implementation of the Replications Algorithm to automatically select the no. of replications for a Discrete-Event Simulation.

The main tutorial can be found in the automated_reps.ipynb notebook.

License

The materials have been made available under an MIT license. The materials are as-is with no liability for the author. Please provide credit if you reuse the code in your own work.

Citation

Please feel free to use or adapt the code for your own work. But if so then a citation would be very much appreciated!

bibtex @software{The_replications_algorithm, author = {Monks, Thomas }, license = {MIT}, title = {{The replications algorithm for DES in Python}}, url = {https://github.com/TheOpenScienceNerd/replications-algorithm} }

Installation instructions

Installing dependencies

All dependencies can be found in binder/environment.yml and are pulled from conda-forge. To run the code locally, we recommend installing miniforge;

miniforge is Free and Open Source Software (FOSS) alternative to Anaconda and miniconda that uses conda-forge as the default channel for packages. It installs both conda and mamba (a drop in replacement for conda) package managers. We recommend mamba for faster resolving of dependencies and installation of packages.

navigating your terminal (or cmd prompt) to the directory containing the repo and issuing the following command:

bash mamba env create -f binder/environment.yml

Activate the mamba environment using the following command:

bash mamba activate rep_alg

Run Jupyter-lab

bash jupyter-lab

Repo overview

. ├── binder │   └── environment.yml ├── callcentresim │   ├── __init__.py │   ├── model.py │   └── output_analysis.py ├── CHANGELOG.md ├── CITATION.cff ├── LICENSE ├── images │   └── ... ├── automated_reps.ipynb ├── README.md └── rep_utility.py

  • environment.yml - contains the conda environment if you wish to work locally algorithm
  • automated_reps - main notebook file containing the tutorial code for the replications algorithm
  • rep_utility - local python module with supporting code for the algorithm
  • callcentresim - local python package containing the urgent care call centre SimPy model.
  • images -images for the notebook
  • CHANGES.md - changelog with record of notable changes to project between versions.
  • CITATION.cff - citation information for the package.
  • LICENSE - details of the MIT permissive license of this work.

Owner

  • Name: TheOpenScienceNerd
  • Login: TheOpenScienceNerd
  • Kind: organization
  • Location: United Kingdom

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: The replications algorithm for DES in Python
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/TheOpenScienceNerd/replications-algorithm'
keywords:
  - discrete-event simulation
  - simpy
  - python
  - open science
  - simopt
license: MIT

GitHub Events

Total
  • Release event: 1
  • Watch event: 1
  • Public event: 1
  • Push event: 1
  • Create event: 1
Last Year
  • Release event: 1
  • Watch event: 1
  • Public event: 1
  • Push event: 1
  • Create event: 1

Dependencies

binder/environment.yml pypi
  • treat-sim *