[kepler-dev] Beta1 Freeze

[Christopher Brooks]

Hi Matt,
Just to add my ever present $0.02.  For the Ptolemy project,
a good demo has:

- An annotation that describes what the demo demonstrates.
The annotation should describe why the demo is cool
to a non-expert (pointy haired boss, Mom, etc.)

- A title annotation can be nice.

- The name should reflect the title.  For Ptolemy, Demo
names should follow Java identifier rules so we can easily
do codegen, for example: WirelessDistance, not wireless_distance.
The reason is so that we can do codegen.
Kepler need not follow this rule.  However, uniform
naming of files is a total win.

- If the model has a limitation, there should be an annotation
in a different color, maybe a smaller font, that lists
the limitation.  Limitations include the fact that the
model needs additional software or access to a database
that is not shipped with the product etc.

- Ptolemy demo usually have an author annotation.  This helps
promote pride of ownership and results in increased maintainability.
I see you suggest that as well for Kepler.

- Ptolemy demos should display in a 1024x768 display.
The reason: That is the size of laptop that Edward and I have.
The way to check this is in Kepler do Help -> About ->
Getting Started -> Ptolemy introduction -> Copyright
  -> Other information about this configuration
  -> Check model sizes and centering
I'm not sure if Kepler wants to follow this standard or not.


Anyway, these are the Ptolemy guidelines for a good demo,
Kepler demos need not follow these guidelines.

_Christopher

--------

    Two addenda:
    
    1) When choosing and providing your example workflows for your projects, 
    please make sure they work but also please be sure to document them -- 
    provide annotations on the canvas that explain the purpose and approach 
    of the workflow, and provide the workflow author name and the date.  I 
    did this within the the Kepler documentation framework so that 'Display 
    documentation' shows something reasonable.  The getting-started-guide 
    examples are a good place to look for examples.
    
    2) Please name your workflows consistently and with informative names -- 
    most people will not be familiar and as these are dmeos the file names 
    should be descriptive.  You might look at the filenames in the 
    getting-started-guide directory for examples.
    
    Thanks.
    
    Matt
    
    Dan Higgins wrote:
    > Hi All,
    >     Due to confusion about the branch, we decided to base the beta 1 
    > release on the head of CVS as of 4PM Pacific time today (22 May). I will 
    > tag the head at that time and the Beta1 release will be based on that 
    > tag. So with the exception discussed below, please do not add any new 
    > code to CVS with the tag 'KEPLER_1_0_0_BETA1". If you have some 
    > important bug fix. please contact me to coordinate it. [NOTE: new work 
    > can be added to the HEAD with no problem. It just won't be in the release
   .]
    > 
    >     Now for the exception. Currently, Matt has added a demos folder 
    > directly under $KEPLER. There is a 'getting-started' folder inside. 
    > Currently, the head of CVS has a 'workflows' directory with a large 
    > number of somewhat confusingly organized workflow examples in a bunch of 
    > subdirectories. A very large number of these workflows do not run! So we 
    > are planning to NOT include the workflows directory in the release. 
    > Instead we would like like to have some new directories added parallel 
    > to the $KEPLER/demos/getting-started/ directory. These directories 
    > should be organized by project (e.g. I will add a 'SEEK' directory; 
    > other might be CIPRES, SPA, etc.) These directories should contain ONLY 
    > workflows that the project is very confident will actually execute! 
    > (Thus, this forces someone to check each one added.) Hopefully, you can 
    > add such example directories in the next few days. Just add to the head 
    > of CVS. I will add the proper tags to incorporate in the release.
    > 
    > 
    > 
    >     Questions always welcome.
    > 
    > Dan
    > 
    _______________________________________________
    Kepler-dev mailing list
    Kepler-dev at ecoinformatics.org
    http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev
--------