Using the Genome Class Browser

####Introduction

The GMS system is large with a complex object oriented code base. The GMS Class Browser provides a graphical user interface to interact with it. Some of the useful features:

• A visual representation of class dependencies
• The properties of each class and how those properties are inherited
• Public and private methods available for each class
• How each Genome class relates to PostGres schema and table definitions
• For example: You might use it to quickly learn the properties you can put after genome model list --show

####Tutorial

Note: To use the class browser you will need to be on a GMS system with a graphical display or you will need to log into that system with display forwarding working (e.g. by ssh -Y $hostname)

To launch the class browser from the source code directory (git repo or snapshot):

cd /opt/gms/U6GNV74/sw/genome/lib/perl/Genome
ur sys class-browser --namespace-name Genome --port 8081

Paste the resulting URL in your web browser: http://localhost.localdomain:8081/

You see will see a GUI that looks like this.

• Navigate this interface by selecting the desired class at the left
• Under Class Metadata you will see a property table_name that indicates the database table the current class corresponds to (if applicable)
• Use the Show inherited properties check box to activate or deactivate the display of properties inherited by the class
• Scroll down to a see a list of public and private methods associated with the class.