The OpenMI documentation
All aspects of the project are documented in the OpenMI report series, comprising the following titles:
A. Scope
Describes the scope of the OpenMI architecture and the organisation behind it.
B. The Guidelines
Describes how to migrate, link and run OpenMI-compliant models. The document includes sample code and tutorial examples.
C. org.OpenMI.Standard interface specification
Describes the interface specification of the org.OpenMI.Standard namespace (the OpenMI standard interface specification). The specification is expressed in Universal Modelling Language (UML) and in API-terms. This specification has to be adopted for a model to become OpenMI-compliant.
D. org.OpenMI.Backbone technical documentation
Describes the default implementation (i.e. the classes that implement the org.OpenMI.Standard interface). This implementation is the basis of the OpenMI environment.
E. org.OpenMI.Development Support technical documentation
Describes a generic set of low-level classes that can be used in the development of an OpenMI system.
F. org.OpenMI.Utilities technical documentation
Describes the org.OpenMI.Utilities namespace, which contains useful low-level classes and packages that have been tailored to help with the development of OpenMI-compliant systems. Their use is entirely optional and is not a requirement of compliance. Typically, the classes within this namespace have been developed to reduce the amount of re-engineering needed when migrating existing model engines and software systems to become OpenMI-compliant. In particular, the utilities provide facilities to support the wrapping of legacy code. The namespace contains packages for wrapping, buffering, spatial mapping, advanced control features, configuration and deployment.
Other documents:
- UML Diagram org.OpenMI.Standard A3 format
- UML Diagram org.OpenMI.Standard A4 format
- The OpenMI standard in a nutshell
...
Links:
- Installation info
- The OpenMI Web site: www.openmi.org
- OpenMI source code at http://sourceforge.net/projects/openmi/
