OpenCOR

OpenCOR is a frontend to libOpenCOR, a library that can be used to organise, edit, simulate, and analyse CellML files.

There are two versions of OpenCOR:

1. OpenCOR: a desktop application that can be run on Windows, Linux, and macOS; and
2. OpenCOR's Web app: a Web app that can be run using a Web browser.

The main difference between the two versions is that models in OpenCOR are, by default, compiled while they can only be interpreted in OpenCOR's Web app.

Prerequisites

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

npm install -g pnpm

Scripts

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

pnpm install

Then, you can run a given script:

pnpm <script>

where <script> is one of the following:

• build: build OpenCOR;
• build:libopencor: build OpenCOR's JavaScript interface to the C++ bindings of libOpenCOR;
• 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; and
• start:web: start OpenCOR's Web app in production mode.