README

SimulationVuer

SimulationVuer is a Vue component to configure and run a CellML-based model of some biological process, and to visualise the results of that simulation.

How to use

To install the package to your Vue application:

npm install @abi-software/simulationvuer

To include the package in your script:

import { SimulationVuer } from '@abi-software/simulationvuer';
import '@abi-software/simulationvuer/dist/simulationvuer.css';

To register in a Vue component:

export default {
  ...
  components: {
    ...,
    SimulationVuer,
    ...
  }
  ...
}

The above registers the SimulationVuer component into the global scope. You can now use the SimulationVuer in your Vue template as follows:

<SimulationVuer :apiLocation="apiLocation" />

where apiLocation is the URL to the API location.

Project setup

Clone the respository

git clone https://github.com/ABI-Software/simulationvuer.git

Vue component

Setup

npm install

Run the sample application

npm run serve

Compile and minify for production

npm run build-bundle

Lint and fix files

npm run lint

Usage no npm install needed!