@quantalabs/epijs

EpiJS

The epidemiology package for JavaScript

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 @quantalabs/epijs
yarn add @quantalabs/epijs

Require:

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

On the web:

<script src="https://cdn.jsdelivr.net/gh/Quantalabs/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

Clone the repo:

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

See CONTRIBUTING.md for details.

Running Tests

To run tests, run the following command

npm run test

Related

• epispot - https://github.com/epispot/epispot
• CovaSim - https://covasim.org

Appendix

• Homepage - https://epi.js.org
• Docs - https://epi.js.org/getting-started.html
• Demo - https://epi.js.org/demo/

Support

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

Changelog

v2.0.0 - LTS

• Stochastic modelling,
• Custom models in com module,
• New pre-built compartments for you to use in comp, including:
  • Susceptible,
  • Exposed,
  • Infected,
  • Hospitalized,
  • Critical,
  • Recovered,
  • Dead,
  • and Vaccinated compartments,
• A new utils compartment, which has epidemiological related utilities,
• Bug fixes,
• Customizable plotting, with the plots module,
• Allows for more interaction with data from pre module,
• And metadata on the web, through EpiJS.about, EpiJS.version, etc.

What makes this a major release?

This release is a major release for 2 reasons:

• Drops 10.x support
• Syntax for functions/classes was changed with stochastic models
• pre module no longer outputs graphs, and is instead replaced with the plots module for graphs.

This release is also an LTS release, so bug fixes and security fixes for a while now.