Skip to content

Latest commit

 

History

History

plugin-worker

README.md

@sdeverywhere/plugin-worker

This package provides a plugin that generates a worker.js file that can run a System Dynamics model (as generated by SDEverywhere) asynchronously in a Web Worker or Node.js worker thread.

Quick Start

The best way to get started with SDEverywhere is to follow the Quick Start instructions. If you follow those instructions, the @sdeverywhere/plugin-worker package will be added to your project automatically, in which case you can skip the next section and jump straight to the "Usage" section below.

Install

# npm
npm install --save-dev @sdeverywhere/plugin-worker

# pnpm
pnpm add -D @sdeverywhere/plugin-worker

# yarn
yarn add -D @sdeverywhere/plugin-worker

Usage

TODO: This section needs to be fleshed out. In the meantime, you can refer to the API documentation below for the options used to configure this plugin.

Documentation

API documentation (for plugin configuration options) is available in the docs directory.

License

SDEverywhere is distributed under the MIT license. See LICENSE for more details.