Skip to content

epispot/EpiJS

EpiJS

The epidemiology package for JavaScript

License: GPL--3.0 npm version npm downloads GitHub issues GitHub pull requests Build Status


About

EpiJS is a epidemiological modelling package for JavaScript with built-in support for SIR-based models including SIR, SEIR, SEIRD, and other models, along with allowing you to create custom models, model community spread through SIR based models, and more.

Installation

NodeJS:

npm install @epispot/epijs
yarn add @epispot/epijs

Require:

const epijs = require('@epispot/epijs')


On the web:

<script src="https://cdn.jsdelivr.net/gh/epispot/EpiJS/web/index.min.js"></script>

Features

  • Pre-built SIR-based models and plotting
  • Community Spread
    • Create Viruses
    • Create Communities
    • Compare two outbreaks
  • Custom models
  • Stochastic Modelling
  • Pre-built customizable compartments

Contributing

Open in Visual Studio Code

Clone the repo:

git clone https://github.com/epispot/epijs.git 
cd EpiJS
npm install

See CONTRIBUTING.md for details.

Running Tests

To run tests, run the following command

npm run test

Related

Appendix

Support

For support, consult the docs or submit a discussion on the repo