[kepler-dev] Beta1 Freeze

[Bertram Ludaescher]

Christopher:

I like those conventions and suggestions. Doing a layout for a
"typical size" window, documentation and file name conventions etc
seem all very good ideas. And all of these also seem compatible w/
what Matt suggested earlier. So I think we should adopt them (unless
there's specific reasons not to).

cheers

Bertram


>>> On Tue, 23 May 2006 10:32:45 -0700
>>> "Christopher Brooks" <cxh at eecs.berkeley.edu> wrote: 
CB> 
CB> Hi Matt,
CB> Just to add my ever present $0.02.  For the Ptolemy project,
CB> a good demo has:
CB> 
CB> - An annotation that describes what the demo demonstrates.
CB> The annotation should describe why the demo is cool
CB> to a non-expert (pointy haired boss, Mom, etc.)
CB> 
CB> - A title annotation can be nice.
CB> 
CB> - The name should reflect the title.  For Ptolemy, Demo
CB> names should follow Java identifier rules so we can easily
CB> do codegen, for example: WirelessDistance, not wireless_distance.
CB> The reason is so that we can do codegen.
CB> Kepler need not follow this rule.  However, uniform
CB> naming of files is a total win.
CB> 
CB> - If the model has a limitation, there should be an annotation
CB> in a different color, maybe a smaller font, that lists
CB> the limitation.  Limitations include the fact that the
CB> model needs additional software or access to a database
CB> that is not shipped with the product etc.
CB> 
CB> - Ptolemy demo usually have an author annotation.  This helps
CB> promote pride of ownership and results in increased maintainability.
CB> I see you suggest that as well for Kepler.
CB> 
CB> - Ptolemy demos should display in a 1024x768 display.
CB> The reason: That is the size of laptop that Edward and I have.
CB> The way to check this is in Kepler do Help -> About ->
CB> Getting Started -> Ptolemy introduction -> Copyright
-> Other information about this configuration
-> Check model sizes and centering
CB> I'm not sure if Kepler wants to follow this standard or not.
CB> 
CB> 
CB> Anyway, these are the Ptolemy guidelines for a good demo,
CB> Kepler demos need not follow these guidelines.
CB> 
CB> _Christopher
CB> 
CB> --------
CB> 
CB>     Two addenda:
CB>     
CB>     1) When choosing and providing your example workflows for your projects, 
CB>     please make sure they work but also please be sure to document them -- 
CB>     provide annotations on the canvas that explain the purpose and approach 
CB>     of the workflow, and provide the workflow author name and the date.  I 
CB>     did this within the the Kepler documentation framework so that 'Display 
CB>     documentation' shows something reasonable.  The getting-started-guide 
CB>     examples are a good place to look for examples.
CB>     
CB>     2) Please name your workflows consistently and with informative names -- 
CB>     most people will not be familiar and as these are dmeos the file names 
CB>     should be descriptive.  You might look at the filenames in the 
CB>     getting-started-guide directory for examples.
CB>     
CB>     Thanks.
CB>     
CB>     Matt
CB>     
CB>     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
CB>    .]
>> 
>> 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
>> 
CB>     _______________________________________________
CB>     Kepler-dev mailing list
CB>     Kepler-dev at ecoinformatics.org
CB>     http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev
CB> --------
CB> _______________________________________________
CB> Kepler-dev mailing list
CB> Kepler-dev at ecoinformatics.org
CB> http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev