Permalink
Browse files

Initial commit...

  • Loading branch information...
0 parents commit 847a6fd9aada4e5ece59515bd7bb2cc1d8276a9f Mannie Tags committed Aug 18, 2009
Showing with 5,962 additions and 0 deletions.
  1. +165 −0 LICENCE
  2. +80 −0 README
  3. +301 −0 doc/LICENCE.html
  4. +251 −0 doc/README.html
  5. +184 −0 doc/T2Flow.html
  6. +203 −0 doc/T2Flow/Coordination.html
  7. +382 −0 doc/T2Flow/Dataflow.html
  8. +241 −0 doc/T2Flow/DataflowAnnotation.html
  9. +203 −0 doc/T2Flow/Datalink.html
  10. +334 −0 doc/T2Flow/Dot.html
  11. +654 −0 doc/T2Flow/Model.html
  12. +219 −0 doc/T2Flow/Parser.html
  13. +301 −0 doc/T2Flow/Processor.html
  14. +184 −0 doc/T2Flow/Sink.html
  15. +185 −0 doc/T2Flow/Source.html
  16. +1 −0 doc/created.rid
  17. BIN doc/images/brick.png
  18. BIN doc/images/brick_link.png
  19. BIN doc/images/bug.png
  20. BIN doc/images/bullet_black.png
  21. BIN doc/images/bullet_toggle_minus.png
  22. BIN doc/images/bullet_toggle_plus.png
  23. BIN doc/images/date.png
  24. BIN doc/images/find.png
  25. BIN doc/images/loadingAnimation.gif
  26. BIN doc/images/macFFBgHack.png
  27. BIN doc/images/package.png
  28. BIN doc/images/page_green.png
  29. BIN doc/images/page_white_text.png
  30. BIN doc/images/page_white_width.png
  31. BIN doc/images/plugin.png
  32. BIN doc/images/ruby.png
  33. BIN doc/images/tag_green.png
  34. BIN doc/images/wrench.png
  35. BIN doc/images/wrench_orange.png
  36. BIN doc/images/zoom.png
  37. +269 −0 doc/index.html
  38. +116 −0 doc/js/darkfish.js
  39. +32 −0 doc/js/jquery.js
  40. +114 −0 doc/js/quicksearch.js
  41. +10 −0 doc/js/thickbox-compressed.js
  42. +52 −0 doc/lib/t2flow/dot_rb.html
  43. +56 −0 doc/lib/t2flow/model_rb.html
  44. +54 −0 doc/lib/t2flow/parser_rb.html
  45. +696 −0 doc/rdoc.css
  46. +250 −0 lib/t2flow/dot.rb
  47. +200 −0 lib/t2flow/model.rb
  48. +192 −0 lib/t2flow/parser.rb
  49. +33 −0 t2flow.gemspec
165 LICENCE
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
80 README
@@ -0,0 +1,80 @@
+= Taverna[http://taverna.sourceforge.net] 2 Interaction Gem
+
+Author:: Emmanuel Tagarira
+Version:: 0.0.0
+Contact:: mailto:emmanuel.tagarira@student.manchester.ac.uk
+URL:: http://taverna.sourceforge.net/
+Licence:: LGPL 3 (See LICENCE or http://www.gnu.org/licenses/lgpl.html)
+Copyright:: (c) 2008-2009 University of Manchester, UK
+
+
+
+== Synopsis
+
+This is a Ruby library to support the interaction with Taverna[http://taverna.sourceforge.net] version 2 workflows (T2Flows). This relies on the functionality provided by the libxml library. To be able to utilise this gem to its full potential, you will need to have the following installed on your system.
+- GraphViz[http://www.graphviz.org/Download.php] (a graph visualization package)
+- Rdoc gem
+- Darkfish-Rdoc gem
+
+
+
+== The T2Flow Model Implementation
+
+Much like the Taverna[http://taverna.sourceforge.net] 1 Scufl model, T2Flows contain Processors, Sinks, and Sources. T2Flows however, encapsulate these elements within Dataflow objects. A Dataflow objects is the container for all the different elements present within the Taverna[http://taverna.sourceforge.net] 2 workflows, hence a single T2Flow may have one or more dataflows. WorkflowDescriptions and Links, from the original Taverna[http://taverna.sourceforge.net] 1 workflows (Scufl), have been renamed in T2Flows to DataflowAnnotations and Datalinks respectively. DataflowAnnotations, however, allow for multiple titles, authors, and descriptions, as opposed to the single value attributes held for Scufls.
+
+
+
+== Installation
+To install the gems required by the Taverna 2 gem library, type into your command prompt:
+ [sudo] gem install libxml-ruby
+ [sudo] gem install rdoc
+ [sudo] gem install darkfish-rdoc
+
+When you have the required gems on your system, you may install this gem using the following commands:
+ gem sources -a http://gems.github.com
+ [sudo] gem install mannie-taverna-t2flow
+
+
+
+== Usage
+
+To be able to generate at least a T2Flow model using the gem, you need to include in your ruby code the following lines:
+ require "t2flow/model.rb"
+ require "t2flow/parser.rb"
+
+To generate the model you can then use the gem as follows:
+ foo = File.new("path/to/workflow/file", "r")
+ bar = T2Flow::Parser.new.parse(foo)
+
+Alternatively:
+ foo = File.new("path/to/workflow/file", "r").read
+ bar = T2Flow::Parser.new.parse(foo)
+
+You will then be able to use your T2Flow model to retrieve information about the workflow by invoking the different methods and attributes.
+ bar.INVOKED
+... where INVOKED is the method or attribute required.
+
+You can also interact with remote workflows.
+ require "open-uri"
+
+ foo = Uri.parse("xxxx://uri_to_workflow").read
+ bar = T2Flow::Parser.new.parse(foo)
+
+To be enable you to draw images of the T2Flow, you need to include:
+ require "t2flow/dot.rb"
+
+To be able to use any functionality included in "t2flow/dot.rb", you need to have GraphViz[http://www.graphviz.org/Download.php] installed on your system. Once this package has been installed, you may use the gem to draw an image showing the structure of the T2Flow as follows.
+ out_file = File.new("path/to/file/you/want/the/dot/script/to/be/written", "w+")
+ T2Flow::Dot.new.write_dot(out_file, bar)
+ `dot -Tpng -o"path/to/the/output/image" #{out_file.path}`
+The last line draws a PNG image using +out_file+. To learn more about dot, try typing into your command prompt:
+ % man dot
+or
+ % dot -h
+
+
+
+== References
+
+[1] http://taverna.sourceforge.net
+[2] http://www.graphviz.org
Oops, something went wrong.

0 comments on commit 847a6fd

Please sign in to comment.