OntologyDBWiki/DeveloperDocumentation/GettingStarted

From BRF-Software
Revision as of 12:27, 9 June 2005 by imported>KaiRunte
Jump to navigation Jump to search

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

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