Plant Ontology: Developers guide to CVS access
Get an account from CVS administrator
Before getting started get your user_login name and password from Peter Van Buren by mentioning
Request for user account on: brebiou.cshl.edu
Your name:
Institution:
Email address:
Office or lab telephone number:(xxx)-xxx-xxxxIf you already have one, do not worry, it will work. Once you have established your account on brebiou.cshl.edu, start with the following depending on the type of machine from which you will be accessing the CVS repository.
CVS access via unix or linux machines
If you prefer a command line access via a unix or linux machines try this
Set up a directory on your home box: ontology
cd ontology
CSHL servers require that you use secure shell:
setenv CVS_RSH ssh
Get the files by doing a check out (co) of the "Poc" module with the following command:
cvs -d user_name@brebiou.cshl.edu:/home/cvs co Poc
In order to update an ontology do this
-cvs update
-cvs commitfor your edited file.
It is good practice always to update a file before revising it.
There is a helpful O'Reilly "CVS Pocket Reference" by G.N. Purdy.
If you need help in depositing your ontology please contact one of us
Doreen Ware, Shuly Avraham, Pankaj Jaiswal
CVS access via windows
If you have an account on the brebiou CVS server, you can use SSH client to access the CVS (it is simple to set up, thus no instructions provided). However, if you are interested in accessing the CVS from your desktop, I suggest using the freeware WinCvs.
For downloading the freeware please go to http://www.wincvs.org/download.html
Following section tells you about setting up and accessing the CVS via windows machine by using WinCvs.
After you have downloaded the freeware, install it on your machine.
It might install in a default directory C:\Program Files\GNU\ on your hard drive.
Look for wincvs.exe file under C:\Program Files\GNU\WinCvs 1.3
Execute the file by clicking on wincvs.exe
It will open a WniCvs panel (image-1). Do not worry if a waring message appears saying you do not have python installed. Just ignore.Image-1
In the mean time, using your windows explorer, create a SANDBOX directory in your favourite location calling it "ontology"Now come back to the WinCvs window (image-1)
In the menu section on top, go to "Admin" and "Preferences"
A small window for WinCvs preference (image-2) pops up.
WinCvs preference:
Go to "general" and configure the settings as follows:
Authentication: ssh (select from dropdown menu)
In the "Authentication" section after selecting ssh (select from dropdown menu), click on the "settings" button. This opens a new window where you select the "SSH client" and provide the location ssh2.exe file. You can find this by browsing the program directory where you installed the SSH client. Most probably it will be "C:\Program Files\SSH Communications Security\SSH Secure Shell\ssh2.exe"
Path: /home/cvs
Host address: brebiou.cshl.edu
User name: your user name (login name assigned by Peter van Buren from CSHL)
CVSROOT: user_name@brebiou.cshl.edu:/home/cvs
Image-2
On the same window go to "CVS" section (image-3)
Provide a path under HOME (passwords and ~/.cvs* files) where the information on your passwords etc. will be stored.
You may want to have a path C:\Documents and Settings\My Documents\SELF\wincvs
or any other if you want to have it stored at some different place. Remember you will have to create this directory "wincvs" by using your windows explorer.Image-3
After you have setp up these configurations say
OK. Checkout module:
Go to WinCvs menu "Remote" on the WinCvs window (image-1) and select "Checkout module"
It opens a new window "Checkout settings" (image-4).
Go to "Checkout settings" and configure the following
Module name and path on the server: Poc
Local folder to checkout to: Select the location of your SANDBOX directory "ontology".Image-4
On the same window go to "General" section and once again confirm the settings as follows (same as Image-2)
Authentication: ssh (select from dropdown menu)
Path: /home/cvs
Host address: brebiou.cshl.edu
User name: your user name (login name assigned by Peter van Buren from CSHL)
CVSROOT: user_name@brebiou.cshl.edu:/home/cvsAfter you have setp up these configurations say OK
Hitting the OK on "Checkout settings" window will start connecting to the server brebiou.cshl.edu and will propmt you to enter a password (assigned by Peter van Buren, CSHL) in a command line window. After you enter the password hit Enter key and it should start downloading the Poc module to the designated SANDBOX directory "ontology" on your machine.
After it is done with downloading, you are all set to work on these files. You will see the same files under ontology/Poc/ as available from Steinlab Viewcvs (for more info CLICK HERE).
CVS access using Mac Machines
Download the Apple Developers Tookit. It's a free download (you just need to signup for a userid). When you install the developer kit, it installs cvs.
To do a checkout, all you have to do is setup your environment (.bashrc and/or .cshrc) and then do
- cvs login (enter your password when prompted)
cvs co PocThis will check out the Poc module in the current directory. What you can do is create a folder inside the desktop folder (call it sandbox), then open a terminal window and cd to Desktop/sandbox. Now when you run a checkout, the Poc module will end up in a folder on the desktop called "sandbox".
The instructions to do an anonymous checkout are the same.
DAG-Edit software:
This Java application provides an interface to browse, query and edit PO files or any other vocabulary that has a DAG data structure. The most current version of DAG-Edit can be downloaded from the publicly accessible source repository at SourceForge. Help documentation is now included in the program, or is available here: dagedit_userguide/dagedit.html
Working on ontology files:
After you have the DAG-Edit installed and CVS setup woorking, you must be excited to start working on the Ontology files. In the following sections, I am giving an example of the TAIR anatomy files. Soon we will have the PO files
anatomy.ontology -- Anatomical terms and relationships anatomy.defs -- Definitions of anatomical terms development.ontology -- Developmental and growth stage terms and relationships development.defs -- Definitions of developmental and growth stage terms
Open the DAG-Edit program and go to File menu and select Load Terms. This will open a window
-Choose data adapter: GO flat file adapter
-File collection:create a new profile Poc
-File paths: AddTo add a new file browser for the Ontology file you are interested in looking e.g. anatomy.tair see next
-File Name or URL: Enter or browse to find the file \Poc\anatomy\anatomy.tair in your SANDBOX directory "ontology" where you checked out the Poc module.
-Definition file name: Same as above browse to enter the definition file e.g. \Poc\definitions\tair.definition in your SANDBOX directory "ontology" where you checked out the Poc module
-After you have setp up the file paths say OK
-This will start loading the ontology files. In this example the TAIR anatomy ontology.
-If you have made any changes in definition/added a new term/merged two terms/modified the tree etc. you need to save the file by going to "File" menu and selecting "Save".
-After saving, you would like to commit those changes to the CVS. Follow the instructions as follows:
For command line users:
-go to the respective directory by cd ontology/ Poc/anatomy/
-then type:cvs commit(name of your file with new saves).
-this will commit the changes to the file on CVSIt is good practice always to update a file before revising it.
There is a helpful O'Reilly "CVS Pocket Reference" by G.N. Purdy.
If you need help in depositing your ontology please contact one of us
Doreen Ware, Shuly Avaraham, Pankaj Jaiswal
For WinCvs users:
-browse to the file you just saved using the DAG-Edit
-scroll your computer mouse on top of the file name and click right button.
-from the popped up menu select "commit selection"
-enter the log message by typing your comments on "what changes you made in the file"
-hit OK
-This will prompt you to enter your password for our account
-enter the password and hit return key.
-the changes will be committed
It is good practice always to update a file before revising it.
-Go to the respective file in your SANDBOX directory or the whole repository
-select it and click the right mouse button.
-on the popped up window select "Update selection"
-This will prompt you to enter your password for our account
-enter the password and hit return key.
-the updates will be done to the file in your SANDBOX directory
If you need help in depositing your ontology please contact one of us
Doreen Ware, Shuly Avaraham, Pankaj Jaiswal