OntologyDBWiki/DeveloperDocumentation/GettingStarted: Difference between revisions

From BRF-Software
Jump to navigation Jump to search
imported>KaiRunte
No edit summary
imported>KaiRunte
No edit summary
Line 26: Line 26:
* projectmanagement
* projectmanagement
* common
* common
* O2DBI
After having checked out everything, you should run the script
<pre><nowiki>
CVS/bioinfo/ontodb/bin/create_o2dbi_code.sh
</nowiki></pre>
This generates all the O2DBI classes from the configuration file <code><nowiki>CVS/bioinfo/ontodb/src/dbschema/OntoDB.xml</nowiki></code>. Please do '''not''' check this code into CVS unless you add some object methods to one of the classes. Generated code does not need to be in CVS as the configuration file is already in CVS.


== API Documentation ==
== API Documentation ==


The API documentation of OntoDB is not checked in as this causes more
The API documentation of OntoDB is not checked in as this causes more trouble then it's worth. To generate your own copy of the API documentation, simply run the script
trouble then it's worth. To generate your own copy of the API
documentation, simply run the script


<pre><nowiki>
<pre><nowiki>

Revision as of 16:30, 24 July 2006

Getting Started

This HowTo explains briefly how to get started with developing code for OntoDB project.

DB Access

All OntoDB projects are backed by the projectmanagement system GPMS. To be able to work with OntoDB you need an account.

If you are a developer send an email to: MailTo(krunte AT cebitec DOT uni DASH bielefeld DOT de) to get a developer account.

CVS

  • create a working direktory for CVS in your home named 'CVS'
  • cd to that directory and get the projects needed to run OntoDB:
cvs checkout bioinfo/<name of project>

You need to checkout the following projects:

  • ontodb
  • projectmanagement
  • common
  • O2DBI

After having checked out everything, you should run the script

CVS/bioinfo/ontodb/bin/create_o2dbi_code.sh

This generates all the O2DBI classes from the configuration file CVS/bioinfo/ontodb/src/dbschema/OntoDB.xml. Please do not check this code into CVS unless you add some object methods to one of the classes. Generated code does not need to be in CVS as the configuration file is already in CVS.

API Documentation

The API documentation of OntoDB is not checked in as this causes more trouble then it's worth. To generate your own copy of the API documentation, simply run the script

CVS/bioinfo/ontodb/bin/create_html_doc.sh


There is a browsable version of the API at [1] which is kept up-to-date with the CVS version.

Useful Documentation/Links