GenDBWiki/DeveloperDocumentation/UseTheSource: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
= Working with the GenDB Sources (Where to find what!) = | = Working with the GenDB Sources (Where to find what!) = | ||
The list below briefly describes the structure of the | The list below briefly describes the structure of the GenDB repository and the content of each directory. If you are programming within the GenDB environment please respect the existing directory structure. | ||
== The GenDB Core Sources == | == The GenDB Core Sources == | ||
{| border="1" cellpadding="2" cellspacing="0" | {| border="1" cellpadding="2" cellspacing="0" | ||
| | | <tt>gendb/bin/</tt> | ||
| only binaries and executable shell scripts like the | | only binaries and executable shell scripts like the GenDB start up wrapper | ||
|- | |- | ||
| | | <tt>gendb/share/</tt> | ||
| directory for most of the | | directory for most of the GenDB sources | ||
|- | |- | ||
| | | <tt>gendb/share/exec/</tt> | ||
| executable Perl scripts etc | | executable Perl scripts etc | ||
|- | |- | ||
| | | <tt>gendb/share/data/</tt> | ||
| default directory for all kinds of data files, e.g. the | | default directory for all kinds of data files, e.g. the GenDB logo and splash screen images | ||
|- | |- | ||
| | | <tt>gendb/share/doc/</tt> | ||
| directory that contains the | | directory that contains the GenDB documentation | ||
|- | |- | ||
| | | <tt>gendb/share/perl/</tt> | ||
| all Perl sources of the | | all Perl sources of the GenDB system | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/</tt> | ||
| the | | the GenDB core library | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/Common/</tt> | ||
| the | | the GenDB core library | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/DB/</tt> | ||
| a | | a <tt>.pod</tt> file for each class of the database schema automatically created by O2DBI | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/DB_Server/</tt> | ||
| the | | the GenDB core server library; here you can find the manually implemented extensions for each class of the database schema (in several other subdirectories where subclasses exist) | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/Exporter/</tt> | ||
| some exporter modules written for the | | some exporter modules written for the GenDB system, e.g. a FASTA or EMBL export library | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/Importer/</tt> | ||
| some importer modules written for the | | some importer modules written for the GenDB system, e.g. a FASTA or EMBL import library | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/Tools</tt> | ||
| some common library functions implemented for frequently used tools like Blast which are utilized by several classes | | some common library functions implemented for frequently used tools like Blast which are utilized by several classes | ||
|- | |- | ||
| | | <tt>gendb/share/perl/GENDB/Wizard</tt> | ||
| some wizards that were implemented for more complex tasks, e.g. tool creation or job submission | | some wizards that were implemented for more complex tasks, e.g. tool creation or job submission | ||
|- | |- | ||
| | | <tt>gendb/src</tt> | ||
| contains only some raw sources | | contains only some raw sources | ||
|- | |- | ||
| | | <tt>gendb/src/dbschema</tt> | ||
| the | | the GenDB O2DBI database schema | ||
|} | |} | ||
== The GenDB Web Sources == | == The GenDB Web Sources == | ||
Add some text here! | |||
== The GenDB GUI Sources == | == The GenDB GUI Sources == | ||
Add some text here! | |||
Latest revision as of 17:11, 31 October 2011
Working with the GenDB Sources (Where to find what!)
The list below briefly describes the structure of the GenDB repository and the content of each directory. If you are programming within the GenDB environment please respect the existing directory structure.
The GenDB Core Sources
| gendb/bin/ | only binaries and executable shell scripts like the GenDB start up wrapper |
| gendb/share/ | directory for most of the GenDB sources |
| gendb/share/exec/ | executable Perl scripts etc |
| gendb/share/data/ | default directory for all kinds of data files, e.g. the GenDB logo and splash screen images |
| gendb/share/doc/ | directory that contains the GenDB documentation |
| gendb/share/perl/ | all Perl sources of the GenDB system |
| gendb/share/perl/GENDB/ | the GenDB core library |
| gendb/share/perl/GENDB/Common/ | the GenDB core library |
| gendb/share/perl/GENDB/DB/ | a .pod file for each class of the database schema automatically created by O2DBI |
| gendb/share/perl/GENDB/DB_Server/ | the GenDB core server library; here you can find the manually implemented extensions for each class of the database schema (in several other subdirectories where subclasses exist) |
| gendb/share/perl/GENDB/Exporter/ | some exporter modules written for the GenDB system, e.g. a FASTA or EMBL export library |
| gendb/share/perl/GENDB/Importer/ | some importer modules written for the GenDB system, e.g. a FASTA or EMBL import library |
| gendb/share/perl/GENDB/Tools | some common library functions implemented for frequently used tools like Blast which are utilized by several classes |
| gendb/share/perl/GENDB/Wizard | some wizards that were implemented for more complex tasks, e.g. tool creation or job submission |
| gendb/src | contains only some raw sources |
| gendb/src/dbschema | the GenDB O2DBI database schema |
The GenDB Web Sources
Add some text here!
The GenDB GUI Sources
Add some text here!