"
Team:Berkeley Software/Downloads
From 2009.igem.org
(→Supporting Tools) |
|||
| (19 intermediate revisions not shown) | |||
| Line 5: | Line 5: | ||
__TOC__ | __TOC__ | ||
| - | On this page | + | On this page we provide links that access all the code and documentation for the tools that we have written. Clotho, Eugene, Spectacles, and Kepler (workflows and actors) are the four major software projects and all represent a substantial amount of effort. For example in the Clotho project alone there are over '''200 files and 250,000 lines of code'''. Therefore in addition to the source code and documentation, we highly recommend the use of an integrated development environment (Netbeans for example; info below) as well as the use of a [http://en.wikipedia.org/wiki/Revision_control revision control system] (SVN for example; info below). Our code is all open source under a general [http://en.wikipedia.org/wiki/BSD_licenses BSD license] and the majority of the code (99%) is written in [http://en.wikipedia.org/wiki/Java_(programming_language) Java]. |
=== Contact Information === | === Contact Information === | ||
| Line 14: | Line 14: | ||
For emails regarding any desired features: ''clothofeatures AT googlegroups DOT com'' | For emails regarding any desired features: ''clothofeatures AT googlegroups DOT com'' | ||
| - | == '''Clotho Design Environment''' - [[http://sourceforge.net/projects/clothocad/ Code], [http://sourceforge.net/projects/clothocad/support Documentation]] == | + | == '''Clotho Design Environment''' - [[http://sourceforge.net/projects/clothocad/ Executable], [http://sourceforge.net/projects/clothocad/develop Code], [http://sourceforge.net/projects/clothocad/support Documentation]] == |
| - | [[Image:ClothoSplashScreen.png|300px|left|thumb|Clotho Design Environment]] | + | [[Image:ClothoSplashScreen.png|300px|left|thumb|<span style="font-family: Georgia, serif;">Clotho Design Environment Splashscreen (Courtesy of [http://christinetsin.designbinder.com/ Christine Tsin])</span>]] |
| - | The | + | The links (above) connect to [http://sourceforge.net sourceforge] (an open source code distribution website) where the "download now" button on the project main page provides a build of the Clotho core framework. [http://sourceforge.net/projects/clothocad/ '''<span style="color:#FF0000"> This is the standalone version of Clotho and should be downloaded by the majority of Clotho users.</span>'''] In this form Clotho comes packaged along with the following Clotho tools: |
* '''Algorithm Manager''' - tool for running assembly algorithms to create efficient composite device assemblies. | * '''Algorithm Manager''' - tool for running assembly algorithms to create efficient composite device assemblies. | ||
| + | * '''Database Manager''' - tool for modifying entries in the active database connection. | ||
* '''Enzyme Library''' - mechanism for highlighting and locating enzymes in DNA sequences. | * '''Enzyme Library''' - mechanism for highlighting and locating enzymes in DNA sequences. | ||
* '''Features Library''' - library of user defined annotations for DNA sequences. | * '''Features Library''' - library of user defined annotations for DNA sequences. | ||
| Line 26: | Line 27: | ||
* '''Spectacles''' - visual editing environment for device construction. | * '''Spectacles''' - visual editing environment for device construction. | ||
| - | The download is an executable jar file which you can run from your computer. The source code itself is available here as well. This allows advanced users to build Clotho with only the tools they want. In addition you can incorporate the Clotho Remote Method Invocation (RMI) tool which is available there (used to connect with Kepler). Also available is the alpha version of the SPAM (Sequence Packaging And Manipulation) tool and Clotho "Classic" Beta (the older version of Clotho). | + | The download is an executable jar file which you can run from your computer. The source code itself is available here as well. This allows advanced users to build Clotho with only the tools they want. In addition you can incorporate the '''Clotho Remote Method Invocation (RMI) tool''' which is available there (used to connect with Kepler). Also available is the alpha version of the '''SPAM (Sequence Packaging And Manipulation) tool''' and '''Clotho "Classic" Beta''' (the older version of Clotho). |
| - | == '''Eugene Domain Specific Language''' - [[http://sourceforge.net/projects/eugene/ Code], [http://sourceforge.net/projects/eugene/support Documentation]] == | + | == '''Eugene Domain Specific Language''' - [[http://sourceforge.net/projects/eugene/ Executable], [http://sourceforge.net/projects/eugene/develop Code], [http://sourceforge.net/projects/eugene/support Documentation]] == |
| - | [[Image:Eugene.png|150px|right|thumb|Eugene Domain Specific Language]] | + | [[Image:Eugene.png|150px|right|thumb|<span style="font-family: Georgia, serif;">Eugene Domain Specific Language</span>]] |
| - | Here the Eugene programming language interpreter is available. Eugene's interpreter | + | Here the Eugene programming language interpreter is available. Eugene's interpreter was written with [http://www.antlr.org ANTLR]. Also included are example files and information on how to run the tool. We provide both an executable jar which one can run graphically as well as support for command line operation. We strongly recommend you read the comprehensive '''README''' file that comes bundled with the download. In addition [http://en.wikipedia.org/wiki/Syntax_highlighting syntax highlighting] support is available in the download for [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++]. |
| - | [[Image:EugeneCmdLine.png|150px|left|thumb|Eugene Command Line Operation]] | + | [[Image:EugeneCmdLine.png|150px|left|thumb|<span style="font-family: Georgia, serif;">Eugene Command Line Operation</span>]] |
| - | [[Image:EugeneGUI.png|150px|left|thumb|Eugene GUI Operation]] | + | [[Image:EugeneGUI.png|150px|left|thumb|<span style="font-family: Georgia, serif;">Eugene GUI Operation</span>]] |
| - | [[Image:EugeneREADME.png|150px|left|thumb|Eugene [http://sourceforge.net/projects/eugene/support README]]] | + | [[Image:EugeneREADME.png|150px|left|thumb|<span style="font-family: Georgia, serif;">Eugene [http://sourceforge.net/projects/eugene/support README</span>]]] |
| - | [[Image:EugeneSyntax.png|150px|left|thumb|Eugene Syntax Highlighting]] | + | [[Image:EugeneSyntax.png|150px|left|thumb|<span style="font-family: Georgia, serif;">Eugene Syntax Highlighting</span>]] |
<br clear="all"> | <br clear="all"> | ||
== '''Kepler/Clotho Integration''' - [[http://sourceforge.net/projects/keplerclotho/ Code], [http://sourceforge.net/projects/keplerclotho/support Documentation]] == | == '''Kepler/Clotho Integration''' - [[http://sourceforge.net/projects/keplerclotho/ Code], [http://sourceforge.net/projects/keplerclotho/support Documentation]] == | ||
| - | [[Image:Kepler.png|150px|left|thumb|Kepler Actors and Workflows]] | + | [[Image:Kepler.png|150px|left|thumb|<span style="font-family: Georgia, serif;">Kepler Actors and Workflows</span>]] |
We have created a number of workflows and actors for Kepler which are available here. These are available as source code only and require advanced knowledge of not only Java but also the process of building complex Java projects. Much of this project also requires advanced knowledge of [http://kepler-project.org Kepler]. The actors and workflows available are: | We have created a number of workflows and actors for Kepler which are available here. These are available as source code only and require advanced knowledge of not only Java but also the process of building complex Java projects. Much of this project also requires advanced knowledge of [http://kepler-project.org Kepler]. The actors and workflows available are: | ||
| - | + | [[Image:OligoWorkflow.png|150px|left|thumb|<span style="font-family: Georgia, serif;">Oligo Construction File Manipulation Workflow</span>]] | |
| - | * | + | * Assembly Automation Workflow |
| - | * | + | * Oligo Construction File Manipulation Workflow |
| - | * | + | * Clotho Connection Actor: Opens a connection to Clotho via RMI |
| - | + | * Data Retrieval Actors: Get tool data through RMI connection | |
| + | * DialogOption Actor: Allow workflows to retrieve user options at runtime | ||
| + | * Assembly Actors: Special actors for the automation flow | ||
| + | * Reaction Plate Actor: Combines 3 spreadsheets to produce a single sheet for parts, oligos, and plates for each reaction. | ||
| + | |||
We hope to continue to add documentation and tutorials to the sourceforge page in the future and make it easier for those wishing to get involved at a very high level to do so. | We hope to continue to add documentation and tutorials to the sourceforge page in the future and make it easier for those wishing to get involved at a very high level to do so. | ||
| Line 50: | Line 55: | ||
== '''Supporting Tools''' == | == '''Supporting Tools''' == | ||
| - | [[Image:java.png| | + | [[Image:java.png|100px|left|thumb|<span style="font-family: Georgia, serif;">[http://java.sun.com/javase/6/ Java</span>]]] |
| - | [[Image:netbeans.png|150px|left|thumb|Netbeans IDE]] | + | [[Image:netbeans.png|150px|left|thumb|<span style="font-family: Georgia, serif;">[http://www.netbeans.org Netbeans IDE</span>]]] |
| - | [[Image:svn.png|150px| | + | [[Image:svn.png|150px|left|thumb|<span style="font-family: Georgia, serif;">[http://subversion.tigris.org Subversion</span>]]] |
| - | Clotho and all its tools along with the Eugene interpreter all require Java 6. You can get it [http://java.sun.com/javase/6/ here]. Also there are a number of issues regarding using Java 6 on Macs. More information on getting Clotho to run on Macs is available [ | + | Clotho and all its tools along with the Eugene interpreter '''all require Java 6'''. You can get it [http://java.sun.com/javase/6/ here]. In general we recommend that you have the latest version of Java installed on whatever machine you run Clotho on. Also there are a number of issues regarding using Java 6 on Macs. More information on getting Clotho to run on Macs is available [http://sourceforge.net/projects/clothocad/support here]. We have gotten Clotho to run on many Mac configurations. ''Please don't give up and please contact us if you have further questions.'' |
| - | Clotho is developed using the [http://www.netbeans.org Netbeans] Integrated Development Environment. We highly recommend you use Netbeans to avoid any potential difficulties. In particular Netbean's GUI builder creates .form files which allow for the creation of Java Swing based GUI elements. | + | Clotho is developed using the [http://www.netbeans.org Netbeans] Integrated Development Environment. We highly recommend you use Netbeans to avoid any potential difficulties. In particular Netbean's GUI builder creates .form files which allow for the creation of Java Swing based GUI elements. You will need to create a new project with the source code you download as well as add the libraries needed. Many of these libraries are available with the Clotho download while others come with Netbeans. You will need to augment your Netbeans project with these libraries. Please see the documentation for more information on how to build Clotho as a new project. |
| + | Finally, in order to get our code from sourceforge it may be necessary to download [http://en.wikipedia.org/wiki/Subversion_(software) Subversion (SVN) software]. You can get this [http://subversion.tigris.org here]. In particular we recommend [http://tortoisesvn.tigris.org Tortoise SVN] for interactive use as well as [http://www.sliksvn.com/en/download Slik SVN] for a command line version (to use with Netbeans for example). | ||
<br clear="all"> | <br clear="all"> | ||
Latest revision as of 07:19, 26 April 2010
Downloads
On this page we provide links that access all the code and documentation for the tools that we have written. Clotho, Eugene, Spectacles, and Kepler (workflows and actors) are the four major software projects and all represent a substantial amount of effort. For example in the Clotho project alone there are over 200 files and 250,000 lines of code. Therefore in addition to the source code and documentation, we highly recommend the use of an integrated development environment (Netbeans for example; info below) as well as the use of a [http://en.wikipedia.org/wiki/Revision_control revision control system] (SVN for example; info below). Our code is all open source under a general [http://en.wikipedia.org/wiki/BSD_licenses BSD license] and the majority of the code (99%) is written in [http://en.wikipedia.org/wiki/Java_(programming_language) Java].
Contact Information
For general information or to contribute: clothodevelopment AT googlegroups DOT com
For emails regarding any bugs: clothobugs AT googlegroups DOT com
For emails regarding any desired features: clothofeatures AT googlegroups DOT com
Clotho Design Environment - [[http://sourceforge.net/projects/clothocad/ Executable], [http://sourceforge.net/projects/clothocad/develop Code], [http://sourceforge.net/projects/clothocad/support Documentation]]
The links (above) connect to [http://sourceforge.net sourceforge] (an open source code distribution website) where the "download now" button on the project main page provides a build of the Clotho core framework. [http://sourceforge.net/projects/clothocad/ This is the standalone version of Clotho and should be downloaded by the majority of Clotho users.] In this form Clotho comes packaged along with the following Clotho tools:
- Algorithm Manager - tool for running assembly algorithms to create efficient composite device assemblies.
- Database Manager - tool for modifying entries in the active database connection.
- Enzyme Library - mechanism for highlighting and locating enzymes in DNA sequences.
- Features Library - library of user defined annotations for DNA sequences.
- Notepad - basic text editing utility which acts as a virtual lab notebook.
- Parts Manager - parts browser and manager.
- Sequence View - DNA sequence editor and viewer.
- Spectacles - visual editing environment for device construction.
The download is an executable jar file which you can run from your computer. The source code itself is available here as well. This allows advanced users to build Clotho with only the tools they want. In addition you can incorporate the Clotho Remote Method Invocation (RMI) tool which is available there (used to connect with Kepler). Also available is the alpha version of the SPAM (Sequence Packaging And Manipulation) tool and Clotho "Classic" Beta (the older version of Clotho).
Eugene Domain Specific Language - [[http://sourceforge.net/projects/eugene/ Executable], [http://sourceforge.net/projects/eugene/develop Code], [http://sourceforge.net/projects/eugene/support Documentation]]
Here the Eugene programming language interpreter is available. Eugene's interpreter was written with [http://www.antlr.org ANTLR]. Also included are example files and information on how to run the tool. We provide both an executable jar which one can run graphically as well as support for command line operation. We strongly recommend you read the comprehensive README file that comes bundled with the download. In addition [http://en.wikipedia.org/wiki/Syntax_highlighting syntax highlighting] support is available in the download for [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++].
Kepler/Clotho Integration - [[http://sourceforge.net/projects/keplerclotho/ Code], [http://sourceforge.net/projects/keplerclotho/support Documentation]]
We have created a number of workflows and actors for Kepler which are available here. These are available as source code only and require advanced knowledge of not only Java but also the process of building complex Java projects. Much of this project also requires advanced knowledge of [http://kepler-project.org Kepler]. The actors and workflows available are:
- Assembly Automation Workflow
- Oligo Construction File Manipulation Workflow
- Clotho Connection Actor: Opens a connection to Clotho via RMI
- Data Retrieval Actors: Get tool data through RMI connection
- DialogOption Actor: Allow workflows to retrieve user options at runtime
- Assembly Actors: Special actors for the automation flow
- Reaction Plate Actor: Combines 3 spreadsheets to produce a single sheet for parts, oligos, and plates for each reaction.
We hope to continue to add documentation and tutorials to the sourceforge page in the future and make it easier for those wishing to get involved at a very high level to do so.
Supporting Tools
Clotho and all its tools along with the Eugene interpreter all require Java 6. You can get it [http://java.sun.com/javase/6/ here]. In general we recommend that you have the latest version of Java installed on whatever machine you run Clotho on. Also there are a number of issues regarding using Java 6 on Macs. More information on getting Clotho to run on Macs is available [http://sourceforge.net/projects/clothocad/support here]. We have gotten Clotho to run on many Mac configurations. Please don't give up and please contact us if you have further questions.
Clotho is developed using the [http://www.netbeans.org Netbeans] Integrated Development Environment. We highly recommend you use Netbeans to avoid any potential difficulties. In particular Netbean's GUI builder creates .form files which allow for the creation of Java Swing based GUI elements. You will need to create a new project with the source code you download as well as add the libraries needed. Many of these libraries are available with the Clotho download while others come with Netbeans. You will need to augment your Netbeans project with these libraries. Please see the documentation for more information on how to build Clotho as a new project.
Finally, in order to get our code from sourceforge it may be necessary to download [http://en.wikipedia.org/wiki/Subversion_(software) Subversion (SVN) software]. You can get this [http://subversion.tigris.org here]. In particular we recommend [http://tortoisesvn.tigris.org Tortoise SVN] for interactive use as well as [http://www.sliksvn.com/en/download Slik SVN] for a command line version (to use with Netbeans for example).
