GenDBWiki/DeveloperDocumentation/UseTheSource
Jump to navigation
Jump to search
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