Personal tools
You are here: Home → Members → andre's Home → Andre's Test CellML Centre → libCellML → Roadmap → #1: High level CellML API
 

#1: High level CellML API

Contents
  1. Motivation
  2. Proposal
We need a less complicated way for application developers to access the most commonly used parts of the CellML API.
Proposed by
David Nickerson
Proposal type
Architecture
Assigned to release
State
being-discussed

Motivation

There is currently a step learning curve for non-specialist programmers to be able to use the CellML C++ implementation. Many people have expressed the opinion that it is too complicated for a developer to easily add CellML support to their application using the API.

With a higher level API it is hoped to lower the barrier for application developers to easily add CellML support to their applications. It is also hoped to encourage application developers who have already coded their own support for CellML 1.0 to move to use of the standard API and thus gain access to CellML 1.1 models.

Proposal

There are two ways we could go here I think:
  1. Provide a high level API and implementation which hides the complexity of the current API while providing access to the required functionality of the API; or
  2. Perhaps with suitable documentation and illustrative examples the apparent complexity of the current API implementation can be overcome by non-specialist application developers.

We need to evaluate these alternatives and decide which course to follow. The decision will most likely depend on the resources available to follow through with either approach.