(warning)(warning)   REMOVE THIS PAGE WHEN THE PARENT PAGE IS COMPLETED (warning)(warning)

Quick Guide

This Quick Guide gives pointers to information sources which address questiosn typically posed by people who are new to the OpenMI.

  • How to start ?
    • Required skills
      To work with OpenMI it is recommende that the following skills are brought together in the team.
  • object oriented programming (prefereably C# or java)
  • a expert on the code which needs to be migrated
    • Where to find OpenMI code
      OpenMI Standard can be downloaded from the OpenMI Association website: http:/www.openmi.org
      SDK and GUI as provided by OATC can be downloaded from the wiki at http:/public.wldelft.nl/display/OPENMI/OATC+downloads. the SDk is avialble as zip-archive. The GUI is available in a installation package.
    • What is the difference between the Standard and the SDK ?
  • The OpenMI Standard is the application programming interface available as a .Net assembly or a JavaArchive. The OpenMI Standard is provided under LGPL conditions (Lesser General Public Licence).
  • The SDK is a Software Development Kit which can be used to migrate your code and implement the interfaces as defined by the OpenMI Standard. The SDK as provided by the OpenMI Association Technical Committee is available under new BSD licence conditions and can be modified for internal use.
  • The GUI (OmiEd) is a straightforward Graphical User interface, primarily meant for testing purposes. OmiEd is provided by the OpenMI Association Technical Committee under new BSD licence conditions. Its code can be modified for internal use.
    • How to use SDK as provided by the OATC ?
      Please rename the namespace to your own organisations namespace and modify/adapt the code where considered appropriate
    • Where to get help ?
  • The Guidelines (doc.B), the Specification document (C) and the technical documentation of the SDK (Doc.D,E,F) have been develoed as part of the first OpenMI release and provide a huge resource of background information.
  • The OpenMI Association Technical Committee is building a knowledge base of use cases, design patterns and examples at its wiki-page. The answer to your question may thus well be available at http://public.wldelft.nl/display/OPENMI/OATC+knowledge+base
  • If you cannot find the answers here, you might have a look at the OATC forums on SourceForge.net: http://sourceforge.net/projects/openmi.
    Sourceforge is also the place to ask new questions (Forums >> Help), put in change requests (Forums >> Change Request) or report bugs (Tracker >> bugs)
  • Migration to OpenMI
    The Guidelines of the OpenMI Report Series (doc.B) provides a huge resource of information. Chapter 4 is dedicated to migrating of existing model codes.
    • how to get from Fortran core to OpenMI (bottom-up approach)-->Guidelines ch.4.5
  • recommendations/pointers for connecting .net classes with fortran -->Guidelines ch.4.5
  • recommendations/pointers for Java/JNI/fortran ?
    • how to connect to files --> Guidelines ch.5.1, Course ex.xx
    • how to see what happens on a link --> Guidelines ch.5.2

Full Documentation overview (TOC)
Docuemnt A Scope
1 Introduction
1.1 The need for the OpenMI
1.2 Aims and objectives
1.3 Why should organizations adopt the OpenMI?
1.4 The development process
1.4.1 The HarmonIT project
1.4.2 The OpenMI-Life project
1.4.3 Other projects
2 Overview of the OpenMI
2.1 Requirements
2.2 Use cases
2.3 Terminology
2.4 The OpenMI standard interface
2.5 An interface-based open standard
3 Products
3.1 OpenMI software releases
3.1.1 The OpenMI standard interface
3.1.2 The OpenMI Software Development Kit
3.1.3 The OpenMI Graphical User Interface
3.1.4 The OpenMI documentation
3.2 Future services

Document B Guidelines

  • No labels