Menu

Tree [769730] default tip /
 History

Read Only access


File Date Author Commit
 AnnoTools 2011-11-08 Andrew Miller Andrew Miller [75e2de] Merge in cleaner-cxx
 CCGS 2012-04-17 Andrew Miller Andrew Miller [5255c1] Fix a bug in IDA code generation where things c...
 CGRS 2012-02-07 Andrew Miller Andrew Miller [e2d9fc] Fix memory leak in destructor_functor support, ...
 CIS 2012-05-02 Andrew Miller Andrew Miller [5ba4ba] Set some more numerical parameters when integra...
 CUSES 2011-11-08 Andrew Miller Andrew Miller [75e2de] Merge in cleaner-cxx
 CeLEDS 2012-03-20 Andrew Miller Andrew Miller [c3e7a2] Merge
 CeLEDSExporter 2011-11-08 Andrew Miller Andrew Miller [75e2de] Merge in cleaner-cxx
 CeVAS 2012-02-22 Andrew Miller Andrew Miller [0150df] Fix tracker item 3176 - Provide a service that ...
 MaLaES 2012-04-10 Andrew Miller Andrew Miller [1f8e94] Fix tracker item 3222 - MaLaES gives no error o...
 SProS 2011-11-08 Andrew Miller Andrew Miller [75e2de] Merge in cleaner-cxx
 SRuS 2012-04-30 Andrew Miller Andrew Miller [54a8e1] Merge changes accidentally committed on branch
 TeLICeMS 2012-04-18 Andrew Miller Andrew Miller [8d0634] Change FixBison.sed to work on both the GNU and...
 VACSS 2011-11-08 Andrew Miller Andrew Miller [75e2de] Merge in cleaner-cxx
 build 2012-05-02 Andrew Miller Andrew Miller [769730] Bump version to 1.12 to reflect what the next r...
 docs 2012-04-10 Andrew Miller Andrew Miller [9c0aaa] Fix examples to avoid one MSVC warning; add doc...
 examples 2012-04-10 Andrew Miller Andrew Miller [9c0aaa] Fix examples to avoid one MSVC warning; add doc...
 extdep 2012-02-15 Andrew Miller Andrew Miller [d2800d] Fix tracker item 3212 - not all hidden libxml2 ...
 interfaces 2012-02-22 Andrew Miller Andrew Miller [0150df] Fix tracker item 3176 - Provide a service that ...
 java 2011-07-12 Andrew Miller Andrew Miller [1ab932] Merge the use_cmake branch
 patches unknown
 python 2011-08-16 Andrew Miller Andrew Miller [e0fe2c] Fix Python bindings so they now works again. Th...
 scripts unknown
 simple_interface_generators 2012-02-01 Andrew Miller Andrew Miller [56966a] Fix issues with the Python code that were causi...
 sources 2012-04-16 Andrew Miller Andrew Miller [78a31c] Fix STL string usage that trips up debug CRT on...
 tests 2012-04-18 Andrew Miller Andrew Miller [004050] Fix TeLICeMS build; fix tracker 3254 around in-...
 xpath 2011-11-08 Andrew Miller Andrew Miller [75e2de] Merge in cleaner-cxx
 .hgignore 2012-04-04 Andrew Miller Andrew Miller [42e0f6] Fix accidentally overbroad rule in .hgignore th...
 .hgtags 2011-09-14 Andrew Miller Andrew Miller [429ca1] Added tag 1.10 for changeset dc81e239b9e5
 AUTHORS unknown
 CMakeLists.txt 2012-02-08 Andrew Miller Andrew Miller [ba1804] Add a make target to checkout and build Python ...
 COPYING 2011-08-03 Andrew Miller Andrew Miller [314090] Rez (the Mac resource compiler, invoked from CP...
 ChangeLog unknown
 INSTALL 2011-09-20 Andrew Miller Andrew Miller [c68983] Update INSTALL file to reflect that we are now ...
 NEWS 2011-12-13 Andrew Miller Andrew Miller [d48d81] Update documentation slightly
 README 2011-12-13 Andrew Miller Andrew Miller [d48d81] Update documentation slightly
 cda_config.h.in 2011-08-01 Andrew Miller<ak.miller@auckland.ac.nz> Andrew Miller<ak.miller@auckland.ac.nz> [0991c4] Include sys/types.h if it was detected to be pr...

Read Me

CellML DOM API README
---------------------

This is the CellML DOM API, an implementation of the CellML API built on top
of the W3C Document Object Model.

This software requires a recent version of libxml2 to compile correctly.
Please follow the instructions in INSTALL to install this software.

Accessing the API interface reference
-------------------------------------

The CellML API uses IDL (interface definition language) to define all
interfaces available through the API. These IDL files contain documentation of
the interfaces inline, using the doxygen style.

All interfaces live in the interfaces directory, and have a .idl file extension.
For example, the core API interfaces are in interfaces/CellML_APISPEC.idl

You can browse a version of the interface reference documentation (which may
not correspond to the version you have) online at
<http://cellml-api.sourceforge.net/>.
Other documentation, includig information on how to build the API, is available
at that site.

You can also generate the documentation as follows:
  cd interfaces
  doxygen
Documentation will end up in interfaces/docs/html

Using the test programs
-----------------------
You may want to try out the test programs. To simply run the tests, after
configuring and building the API, you simply need to run:
  make check

This will compile and run all tests.

After this, you might want to do some manual tests. Please keep in mind that
the test programs are designed to demonstrate the basics underlying the API, and
not necessarily be useful tools in their own right. For actual modelling work,
we recommend using a tool designed for that purpose, such as OpenCell
(see http://www.opencell.org/).

Some examples:
  To try out the procedural code generation facilities in OpenCell:
    ./CellML2C ./tests/test_xml/SimpleDAE_NonLinear.xml
  You might also want to see that code with names rather than array indices:
    ./CellML2C ./tests/test_xml/SimpleDAE_NonLinear.xml useida
  Or perhaps in IDA style, with names...
    ./CellML2C ./tests/test_xml/SimpleDAE_NonLinear.xml useida usenames
  To see the source code for the CellML2C test program in this file:
    CCGS/tests/CellML2C.cpp

  To try out the CellML Language Export Definition Service (CeLEDS):
    ./testCeLEDS ./tests/test_xml/SimpleDAE_NonLinear.xml ./CeLEDS/languages/MATLAB.xml
  Source code is in CeLEDSExporter/tests/testCeLEDS.cpp

  To try running a simulation:
    LIBRARY_PATH=`pwd`/.libs ./RunCellML tests/test_xml/SimpleDAE_NonLinear.xml step_type ida
  Source code is in CIS/tests/RunCellML.cpp
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.