Ptolemy II 5.0 Release Notes

Ptolemy II is a set of Java packages supporting heterogeneous, concurrent modeling and design. Its kernel package supports clustered hierarchical graphs, which are collections of entities and relations between those entities. Its actor package extends the kernel so that entities have functionality and can communicate via the relations. Its domains extend the actor package by imposing models of computation on the interaction between entities. Examples of models of computation include discrete-event systems, dataflow, process networks, synchronous/reactive systems, and communicating sequential processes.

Ptolemy II includes a number of support packages, such as
data, providing a type system, data encapsulation and an expression parser,
plot, providing visual display of data,
math, providing matrix and vector math and signal processing functions, and
graph, providing graph-theoretic manipulations.

The three volumes of the Ptolemy II Design Document describes the Ptolemy II design and the implementation of the Java classes.

The "Using Vergil" describes how to use Vergil.

Complete List of Domains in Ptolemy II

Platforms

The core of Ptolemy II 5.0 is 100% Java, so it should work on any platform that has JDK 1.4 or later.

We developed Ptolemy II 5.0 under Solaris 8 and Windows XP sp2 and with JDK1.4.2_08.

Ptolemy II 5.0 will not compile under Java 1.3 because we use the java.lang.URI class, which is present only in Java 1.4 and later.

There are various problems with Sun Java 1.5.0:

  • Web Start does not work
  • Caltrop does not work because of XML parser issues
  • Ptolemy II has been compiled and run under IBM JDK 1.4.2_01-b06. There are the following limitations under IBM JDK 1.4.2:

  • The Copernicus code generator does not work.
  • Caltrop does not work.
  • The IBM JDK seems to return directory contents in a different order than the Sun JDK. Thus actor.lib.io.DirectoryListing might return elements in a different order.
  • Contents:

    Highlights

    Other Key New Capabilities

    New and Enhanced Actor Libraries

    A number of new and enhanced actor libraries are included in version 5.0. You may also wish to refer to the ptolemy.actor.lib package, where most of the domain-polymorphic actors reside (domain-polymorphic actors are those that can be used in more than one domain).

    New Demonstrations

    Additional Features

    Bug fixes

    Backward Compatibility

    Most models developed under Ptolemy II 1.0.1, 2.0.1, 3.0.2, 4.01 or HyVisual 2.2-beta an Hyvisual 3.0 should run under Ptolemy II 5.0 The MoMLParser includes a list of backward compatibility filters that make certain changes on models when read, handling such issues as actors being moved or renamed and parameter names being changed. The filters themselves are defined in ptolemy.moml.filter. If you have developed your own actors under earlier versions of Ptolemy II by writing your own Java files, you should recompile all your java code with the new release. In theory, copying the .class files should work, but recompiling is safer.

    Backward compatible issues that are handled automatically

  • ptolemy.moml.filter.AddEditorFactory: If a parameter has a _location, then add a VisibleParameterEditorFactory named _editorFactory.
  • ptolemy.moml.filter.AddIcon: Add specialized icons that display the value of one of the parameters.
    The affected actors are:
  • ptolemy.actor.lib.Const
  • ptolemy.actor.lib.MathFunction
  • ptolemy.actor.lib.TrigFunction
  • ptolemy.actor.lib.Scale
  • ptolemy.actor.lib.Expression
  • ptolemy.moml.filter.ClassChanges: change any class names that have been renamed and remove obsolete classes.
    Below are original class names followed by the new class names:
  • ptolemy.vergil.fsm.modal.ModalController -> ptolemy.domains.fsm.modal.ModalController
  • ptolemy.vergil.fsm.modal.ModalModel$ModalTableauFactory -> ptolemy.vergil.fsm.modal.ModalTableauFactory
  • ptolemy.vergil.fsm.modal.TransitionRefinement -> ptolemy.domains.fsm.modal.TransitionRefinement
  • ptolemy.vergil.fsm.modal.RefinementPort -> ptolemy.domains.fsm.modal.RefinementPort
  • ptolemy.vergil.fsm.modal.Refinement -> ptolemy.domains.fsm.modal.Refinement
  • ptolemy.kernel.util.VersionAttribute -> ptolemy.kernel.attributes.VersionAttribute
  • ptolemy.vergil.icon.ImageEditorIcon -> ptolemy.vergil.icon.ImageIcon
  • ptolemy.vergil.fsm.modal.ModalPort -> ptolemy.domains.fsm.modal.ModalPort
  • ptolemy.vergil.fsm.modal.TransitionRefinementPort -> ptolemy.domains.fsm.modal.TransitionRefinementPort
  • ptolemy.kernel.attributes.FileAttribute -> ptolemy.data.expr.FileParameter
  • ptolemy.domains.sdf.kernel.SDFIOPort -> ptolemy.actor.TypedIOPort
  • ptolemy.moml.Location -> ptolemy.kernel.util.Location
  • ptolemy.domains.fsm.lib.RelationList -> ptolemy.domains.fsm.kernel.RelationList
  • ptolemy.actor.lib.comm.SerialComm -> ptolemy.actor.lib.io.comm.SerialComm
  • ptolemy.actor.hoc.MultiInstanceComposite -> ptolemy.actor.lib.hoc.MultiInstanceComposite
  • ptolemy.vergil.fsm.modal.ModalModel -> ptolemy.domains.fsm.modal.ModalModel
  • Below are the classes to remove:
  • ptolemy.data.expr.NotEditableParameter
  • ptolemy.moml.filter.HideAnnotationNames: If an annotation name ends with 'annotation1', then add _hideName if necessary.
  • ptolemy.moml.filter.MultiportToSinglePort: Update any actor multiports that are now single ports.
    Below are the actors that are affected, along with the port name:
  • input ptolemy.actor.lib.gui.MatrixViewer
  • input ptolemy.domains.sdf.lib.Autocorrelation
  • output ptolemy.actor.lib.Const
  • output ptolemy.actor.lib.NonStrictTest
  • ptolemy.moml.filter.ParameterNameChanges: Update any Parameter names that have been renamed.
    Below are the actors that are affected, along with the Parameter name and the new name:
  • ptolemy.domains.pn.kernel.PNDirector
    Initial_queue_capacity -> initialQueueCapacity
  • ptolemy.moml.filter.PortClassChanges: Update any actor port classes that have been changed.
    Below are the actors that are affected, along with the old port class and the new port class:
  • ptolemy.domains.de.lib.VariableDelay.delay
  • ptolemy.domains.de.kernel.DEIOPort -> ptolemy.actor.parameters.ParameterPort
  • ptolemy.moml.filter.PortNameChanges: Update any actor port names that have been renamed.
    Below are the actors that are affected, along with the old port name and the new port name:
  • ptolemy.actor.lib.comm.Scrambler
  • initial -> initialState
  • ptolemy.actor.lib.conversions.CartesianToComplex
  • imag -> y
  • real -> x
  • ptolemy.actor.lib.comm.ConvolutionalCoder
  • uncodeBlockSize -> uncodedRate
  • initial -> initialState
  • ptolemy.actor.lib.comm.ViterbiDecoder
  • uncodeBlockSize -> uncodedRate
  • amplitude -> constellation
  • ptolemy.actor.lib.Sleep
  • delay -> sleepTime
  • ptolemy.actor.lib.conversions.ComplexToCartesian
  • imag -> y
  • real -> x
  • ptolemy.moml.filter.PropertyClassChanges: Update any actor port class names that have been renamed.
    Below are the actors that are affected, along with the port name and the new classname:
  • ptolemy.domains.sdf.lib.ArrayToSequence
  • ptolemy.domains.sdf.lib.Autocorrelation
  • ptolemy.domains.sdf.lib.BitsToInt
  • ptolemy.domains.sdf.lib.Chop
  • ptolemy.domains.sdf.lib.CountTrues
  • ptolemy.domains.sdf.lib.DoubleToMatrix
  • ptolemy.domains.sdf.lib.DownSample
  • ptolemy.domains.sdf.lib.FFT
  • ptolemy.domains.sdf.lib.FIR
  • ptolemy.domains.sdf.lib.IFFT
  • ptolemy.domains.sdf.lib.IntToBits
  • ptolemy.domains.sdf.lib.LineCoder
  • ptolemy.domains.sdf.lib.MatrixToDouble
  • ptolemy.domains.sdf.lib.MatrixToSequence
  • ptolemy.domains.sdf.lib.Repeat
  • ptolemy.domains.sdf.lib.SampleDelay
  • ptolemy.domains.sdf.lib.SequenceToArray
  • ptolemy.domains.sdf.lib.SequenceToMatrix
  • ptolemy.domains.sdf.lib.UpSample
  • ptolemy.domains.sdf.lib.VariableFIR
  • tokenProductionRate -> null
  • tokenInitProduction -> null
  • tokenConsumptionRate -> null
  • ptolemy.actor.lib.MathFunction
  • function -> ptolemy.data.expr.StringParameter
  • ptolemy.domains.sdf.lib.vq.ImageUnpartition
  • input -> ptolemy.actor.TypedIOPort
  • output -> ptolemy.actor.TypedIOPort
  • ptolemy.actor.lib.TrigFunction
  • function -> ptolemy.data.expr.StringParameter
  • ptolemy.actor.lib.Expression
  • expression -> ptolemy.kernel.util.StringAttribute
  • ptolemy.domains.sdf.lib.vq.HTVQEncode
  • input -> ptolemy.actor.TypedIOPort
  • output -> ptolemy.actor.TypedIOPort
  • ptolemy.domains.sdf.lib.vq.VQDecode
  • input -> ptolemy.actor.TypedIOPort
  • output -> ptolemy.actor.TypedIOPort
  • ptolemy.domains.sdf.lib.vq.ImagePartition
  • input -> ptolemy.actor.TypedIOPort
  • output -> ptolemy.actor.TypedIOPort
  • ptolemy.matlab.Expression
  • expression -> ptolemy.data.expr.StringParameter
  • Features that were new in previous Ptolemy II releases

    Features that were new in previous Ptolemy II releases

    Limitations

    Version 5.0 has the following limitations:

    Release Limitations

    Limitations in the Class Mechanism

    The class mechanism is highly preliminary and is likely to change in future releases. There are several known problems:

    Limitations in the Actor Libraries

    Limitations in the PN Domain

    The PN domain documents that it locally handles mutations. However, this is currently not true in the implementation. For the basic PN model, this doesn't really matter, since mutations happen pretty much the same as they would otherwise. (i.e. they are non-deterministic in when they execute) However, for timed PN models, there is actually some expressiveness lost, since timed PN models can locally execute mutations deterministically.

    Embedding a PN typed composite actor inside a non-process top level such as DE does not work. In fact embedding a process domain inside a non-process domain is likely to have problems. Profess Lee wrote:

    Yes, it looks as if the code is designed so that process domains (PN, CSP) can only be used within process domains. I'm not sure to what extent this is a limitation of the process domains vs. a semantic problem. What would PN mean within DE? Since PN has no well-defined notion of a "firing", how would you assign time stamps to the outputs of a PN actor? By default in DE, the time stamps of the outputs of an actor match those of the inputs that triggered the firing. There is no such notion in PN.

    Limitations in the User Interface

    Below are some of the limitations of Vergil, the Ptolemy II Graphical User Interface.

    Limitations in JNI

  • The Interface to C actors using the Java Native Interface is not available via the Windows Installer (or Web Start). To use the JNI/Ptolemy II interface, you must download Ptolemy II as source files and compile.
  • The JNI user interface does not permit creation of new JNI actors.

    If you follow the instructions in JNIUtilities, then eventually you will get a NameDuplicationException.

    The resulting model will be missing

    <property name="output" class="jni.Argument" value="false,false,true,double">
    </property>
    
    We are working with the original authors on a solution.
    In the short term, one workaround is to edit the xml file directly and add the appropriate property by hand.
  • JNI will not work with Hierarchical classes, subclasses, and inner classes
  • If Ptolemy exits when running the JNI model, then try using gcc-3.2.x in the Cygwin installer from http://ptolemy.eecs.berkeley.edu/ptolemyII/ptII5.0/cygwin.htm which includes gcc-3.2.x
  • Code Generation Limitations

    Code Generation limitations are covered on the Code Generation page.

    Missing Domains

    For limitations discovered after the release, see the Ptolemy II 5.0 website

    Last Updated: $Date: 2005/05/14 00:23:34 $