OpenCOR

OpenCOR is a Web-based modelling environment, which can be used to organise, edit, simulate, and analyse CellML files. It can be used both as a standalone application (on Windows, Linux, and macOS) and on the Web.

Prerequisites

To build OpenCOR, you need to install node.js and npm, which you can do from here. Then, you need to install yarn, which you can do by running:

npm install -g yarn

Scripts

Before doing anything, you need to install all of OpenCOR's dependencies:

yarn

Then, you can run a given script:

yarn <script>

where <script> is one of the following:

• build: build OpenCOR;
• build:web: build OpenCOR's Web app;
• clean: clean OpenCOR's environment;
• dev: start OpenCOR and OpenCOR's Web app in development mode;
• dev:web: start OpenCOR's Web app in development mode;
• format: format OpenCOR's code and OpenCOR's Web app's code;
• format:check: check that OpenCOR's code and OpenCOR's Web app's code are properly formatted;
• lint: lint OpenCOR's code and OpenCOR's Web app's code;
• package: (build and) package OpenCOR for the current platform;
• package:linux: (build and) package OpenCOR for Linux;
• package:mac: (build and) package OpenCOR for macOS;
• package:win: (build and) package OpenCOR for Windows;
• publish:web: publish OpenCOR's Web app on npm;
• start: start OpenCOR in production mode;
• start:web: start OpenCOR's Web app in production mode;
• typecheck: type check OpenCOR's code; and
• typecheck:web: type check OpenCOR's Web app's code.