Difference between revisions of "Protege4GettingStarted"

From Protege Wiki
Jump to: navigation, search
(saving another batch of edits)
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
<div class="orangeBox">
 
<div class="orangeBox">
<span class="orangeBoxTitle">Getting Started with Protege-OWL</span><br /><br />
+
<span class="orangeBoxTitle">Getting Started with Protege Desktop Editor</span><br /><br />
This page contains instructions for getting started with the Protege-OWL editor in Protege 4.0.
+
This page contains instructions for getting started with the Protege Desktop Ontology Editor. Applies to versions 4, 5 and newer.
 
</div><br />
 
</div><br />
 +
  
 
__TOC__
 
__TOC__
  
== Download ==
+
'''Back to [[Protege4UserDocs|Protege Desktop User Documentation]]'''
  
If you haven't already done so, you need to download and install Protege 4.0 from the Protege website.  If you are a new user, please go to the main download page and register first, which helps us to track the number of Protege users:  http://protege.stanford.edu/download/download.html.
 
  
If you are an existing user, you can proceed directly to the installer page:  http://protege.stanford.edu/download/prerelease-alpha/index.html.
+
== Introduction ==
  
'''Note:''' On the main download page, you will also find links to a release notes page for each new build of Protege 4.0, as well as a link to the location of the source code: http://protege.stanford.edu/download/registered.html#p4.
+
Protege is an OWL ontology development environment. This quick start guide forms part of the [[Protege4UserDocs|Protege Desktop user documentation]] and is designed to get you up and running with the tool.  
  
<br />
+
In just a few minutes you should be able to install Protege, load an ontology, navigate around it, use a reasoner to classify it and configure the interface to your taste.
[[Image:download.png|frame|none|screenshot of protege 4.0 installer page]]
 
<br />
 
  
== Install & Run Protege ==
+
== Download ==
  
Once you have navigated to the installer page, click the "Download Installer for <xxx-platform>" button to run the installer:
+
If you haven't already done so, you need to download and install Protege Desktop from the Protege website: http://protege.stanford.edu/products.php#desktop-protege
  
<br />
+
== Install & Run Protege ==
[[Image:install.png|frame|none|screenshot of protege 4.0 installer]]
 
<br />
 
  
Run Protege from the location where you installed shortcuts or from the Protege installation directory specified during the installation process. On a <strong>Windows</strong> machine, you can double-click the Protege executable file (Protege.exe), or use the run batch file (run.bat). If you choose to use the batch file, please make sure the JAVA_PATH variable is set correctly. On the <strong>Mac</strong> there will be a Protege.app, or you can run using one of the scripts. <span style="color:#AF60AF;">Note: by default, Protege 4.0 is configured to run in a fairly small memory footprint ~200MB. To get optimum performance, you can change this using our [[Setting_Heap_Size|instructions on setting the heap size]].</span>
+
Please follow the step-by-step instructions to install Protege from [[Install_Protege5|here]. Basically, you just need to unzip the downloaded archive for your platform, and run either with one of the run scripts (<code>run.bat</code>, <code>run.sh</code>, <code>run.command</code>) or <code>Protege.exe</code> on Windows platforms.
  
You will now be presented with the Welcome screen from which you can create a new ontology or open an existing ontology from your local machine or from the Web. We can start by opening an existing ontology. <span style="color:#AF60AF;">Note: once you have opened or saved an ontology, it will be easily available to click on in the "Open Recent" box.</span>
+
Download the pizza ontology from: http://protege.stanford.edu/ontologies/pizza/pizza.owl (the unclassified version in XML/RDF syntax will work as an example).
  
<br />
+
Select <span style="color:#B87A3D; font-weight:bold;">Open OWL ontology</span> from the Welcome screen and find the <code>pizza.owl</code> file on your filesystem.
[[Image:welcome.png|frame|none|screenshot of protege 4.0 welcome screen]]
 
<br />
 
  
Download the pizza ontology from http://www.co-ode.org/ontologies/pizza (the unclassified version in RDF syntax will work as an example).
+
Alternatively, you may also open the pizza.owl file directly from the Web: Start Protege, File menu -> Open from URL, and enter the URL: http://protege.stanford.edu/ontologies/pizza/pizza.owl
 
 
Select <span style="color:#B87A3D; font-weight:bold;">Open OWL ontology</span> from the Welcome screen and find the <code>pizza.owl</code> file on your filesystem.
 
  
 
You will now be presented with the main Protege workspace, which opens by default to the <span style="color:#B87A3D; font-weight:bold;">Active Ontology</span> tab. This tab shows an overview of the pizza ontology, including metrics on its contents, annotations about the ontology as a whole, and other imported ontologies (if any imports exist). The drop-down on the toolbar displays the currently active ontology, that is to say, the one into which all edits take place. When working on a single ontology this concept of the active ontology is not a concern.
 
You will now be presented with the main Protege workspace, which opens by default to the <span style="color:#B87A3D; font-weight:bold;">Active Ontology</span> tab. This tab shows an overview of the pizza ontology, including metrics on its contents, annotations about the ontology as a whole, and other imported ontologies (if any imports exist). The drop-down on the toolbar displays the currently active ontology, that is to say, the one into which all edits take place. When working on a single ontology this concept of the active ontology is not a concern.
Line 48: Line 40:
 
Now switch to the <span style="color:#B87A3D; font-weight:bold;">Entities Tab</span>.
 
Now switch to the <span style="color:#B87A3D; font-weight:bold;">Entities Tab</span>.
  
The Entities tab is the workhorse of the ontology editor. From this location, you can explore all of the classes, properties and individuals in an ontology. As you may have already noticed, each <span style="color:#B87A3D; font-weight:bold;">tab</span> is made up of several <span style="color:#B87A3D; font-weight:bold;">views</span> which can be resized, removed, floated, split, and layered (more about views later). The selection model is global such that when a class, property or individual is selected in the trees on the left-hand side, the right pane changes to display the selection immediately. In addition, most views implement <span style="color:#B87A3D; font-weight:bold;">hypertext navigation</span> so that links can be followed easily regardless of which view you are using. Opening up the hierarchies and selecting a class or property displays the appropriate description on the right. Backward and forward navigation is possible with the left and right arrow buttons in the toolbar, which act just like a Web browser.  
+
The Entities tab is the workhorse of the ontology editor.
 +
From this location, you can explore all of the classes, properties, and individuals in an ontology.
 +
As you may have already noticed, each <span style="color:#B87A3D; font-weight:bold;">tab</span>
 +
is made up of several <span style="color:#B87A3D; font-weight:bold;">views</span>
 +
which can be resized, removed, floated, split, and layered (more about views later).
 +
The selection model is global:
 +
when a class, property or individual is selected in the trees on the left-hand side,
 +
the right pane changes to display the selection immediately.
 +
In addition, most views implement <span style="color:#B87A3D; font-weight:bold;">hypertext navigation</span>
 +
so that links can be followed easily regardless of which view you are using.
 +
Opening up the hierarchies and selecting a class or property displays the appropriate description on the right.
 +
Backward and forward navigation is possible with the left and right arrow buttons in the toolbar,
 +
which act just like a Web browser.  
  
 
<br />
 
<br />
Line 54: Line 58:
 
<br />
 
<br />
  
Another easy way to navigate around the contents of an ontology is to perform a search. The <span style="color:#B87A3D; font-weight:bold;">find</span> box in the toolbar performs a global search over any named entity in an ontology. In addition, the <span style="color:#B87A3D; font-weight:bold;">hierarchy views</span> have their own find dialogs (first, click anywhere in the view to give it focus, then <code>Ctrl-F</code> on Windows, <code>Command-F</code> on Mac).
+
Another easy way to navigate around the contents of an ontology is to perform a search.
 
+
The <span style="color:#B87A3D; font-weight:bold;">find</span> box in the toolbar
Note that several views are stacked on top of each other. For example, the annotations view has an additional view hidden underneath - the <span style="color:#B87A3D; font-weight:bold;">Usage view</span>. You can show this view by clicking on the greyed-out tab underneath the view.
+
performs a global search over any named entity in an ontology.
 
+
In addition, the <span style="color:#B87A3D; font-weight:bold;">hierarchy views</span>
<br />
+
have their own find dialogs
[[Image:usage.png|frame|none|screenshot of the usage view in the protege-owl editor]]
+
(first, click anywhere in the view to give it focus, then <code>Ctrl-F</code> on Windows, <code>Command-F</code> on Mac).
<br />
 
  
 
== Reasoning ==
 
== Reasoning ==
  
Reasoning with your ontology is a commonly preformed activity and Protege 4.0 comes with 2 built-in reasoners, FaCT++ and Pellet. To <span style="color:#B87A3D; font-weight:bold;">classify your ontology</span>, open the <span style="color:#B87A3D; font-weight:bold;">Reasoner</span> menu and select one of the available reasoners. <span style="color:#B87A3D; font-weight:bold;">FaCT++</span> will automatically classify your ontology. <span style="color:#B87A3D; font-weight:bold;">Pellet</span> requires that you select classify. Once you have done this the class hierarchy on the Entites tab changes to show the <span style="color:#B87A3D; font-weight:bold;">inferred class hierarchy</span>. Unsatisfiable classes appear in red under Nothing and everything else appears in the hierarchy under their inferred superclasses. The asserted class hierarchy is still available, stacked under the asserted one.
+
Reasoning with your ontology is one of the most commonly performed activities and Protege comes with a built-in reasoner called HermiT. To <span style="color:#B87A3D; font-weight:bold;">classify your ontology</span>, open the <span style="color:#B87A3D; font-weight:bold;">Reasoner</span> menu and select HermiT, which will automatically classify your ontology. After the reasoner finishes classifying, an additional sub tab appears on the Entites tab to show the <span style="color:#B87A3D; font-weight:bold;">inferred class hierarchy</span>. Unsatisfiable classes appear in red under Nothing and everything else appears in the hierarchy under their inferred superclasses. The asserted class hierarchy is still available, stacked under the asserted one.
  
 
<br />
 
<br />
Line 70: Line 73:
 
<br />
 
<br />
  
== Investigate Other Tabs ==
+
There are other reasoners available for Protege, including Pellet and FaCT++.  These reasoners are available for download from the File | Check for plugins... menu item.
 +
 
 +
== Investigate other tabs ==
  
 
* <span style="color:#B87A3D; font-weight:bold;">OWLViz</span> - requires installation of [http://www.graphviz.org/ Graphviz] before anything will be visible. This tab shows a graphical representation of the class subsumption hierarchy. A full description of OWLViz is available in the [http://www.co-ode.org/downloads/owlviz/OWLVizGuide.pdf OWLViz manual].
 
* <span style="color:#B87A3D; font-weight:bold;">OWLViz</span> - requires installation of [http://www.graphviz.org/ Graphviz] before anything will be visible. This tab shows a graphical representation of the class subsumption hierarchy. A full description of OWLViz is available in the [http://www.co-ode.org/downloads/owlviz/OWLVizGuide.pdf OWLViz manual].
  
 
* <span style="color:#B87A3D; font-weight:bold;">DL Query</span> - requires the ontology to have been classified before it will return results. An arbitrary class description can be entered and the reasoner is queried for the sub/super classes, inferred members, etc., depending on what is selected.
 
* <span style="color:#B87A3D; font-weight:bold;">DL Query</span> - requires the ontology to have been classified before it will return results. An arbitrary class description can be entered and the reasoner is queried for the sub/super classes, inferred members, etc., depending on what is selected.
<br />
+
 
 +
 
 +
== Investigate views ==
 +
 
 +
Each tab is made up of multiple views - each with its own perspective on the ontology, or just one aspect of the ontology (like the last selected class).
 +
 
 +
Views can be stacked on top of each other, in which case you will see additional tabs for exposing them.
 +
 
 +
Examples of this are the usage views that are by default on the Entities, Classes, Properties and Individuals tabs.
 +
Select the tab to make the view visible.
 +
 
 +
[[Image:UsageViewStackedBehindAnnotations.png|frame|none|screenshot of the usage view hidden behind the annotations view]]
 +
 
 +
[[Image:ClassUsageView.png|frame|none|screenshot of the usage view after selecting its tab]]
 +
 
 +
All of the views that are on tabs by default and many more that aren't are listed in the <span style="color:#B87A3D; font-weight:bold;">Views</span> menu.
 +
You can add and remove views to create you own custom interfaces (see below).
 +
 
  
 
== Reconfigure the User Interface ==
 
== Reconfigure the User Interface ==
  
[[Image:existentialtree.png|frame|right|screenshot of the existential tree view]]
+
Reconfiguring the user interface is easy! Adding and removing tabs and views is possible through the Tabs and View menus. Try removing the Classes and Properties tabs to unclutter the screen. Try adding a view to the Entities tab:
 
 
Reconfiguring the user interface is easy! Adding and removing tabs and views is possible through the Tabs and View menus. Try removing the Classes and Properties views to unclutter the screen. Try adding a view to the Entities tab:
 
  
 +
# Switch back to the Entities Tab
 
# Select a class to make sure the Selected Entity view is showing class views.
 
# Select a class to make sure the Selected Entity view is showing class views.
# Select View | Class Views | Existential Tree. Now, when you float over the editor, a blue outline shows where the new view will be dropped - either on top of, above, below, left, or right of each of the current views.
+
# Select <span style="color:#B87A3D; font-weight:bold;">Window | Views | Class Views | Asserted Superclass Hierarchy</span>. Now, when you float over the editor, a blue outline shows where the new view will be dropped - either on top of, above, below, left, or right of each of the current views.
 
# When happy with the position, click the left mouse button to drop the view (if you want to cancel this operation just click somewhere on the toolbar instead).
 
# When happy with the position, click the left mouse button to drop the view (if you want to cancel this operation just click somewhere on the toolbar instead).
# The existential tree view is now visible (the tree follows existential restrictions along the specified properties and is useful for partonomic relations).
+
# The superclass tree view is now visible (the tree shows the "upside-down" version of the subclass tree, using the current class as the root).
 +
 
 +
All changes will be saved when Protege is properly shut down (or the save can be forced by selecting "Save current layout" in the Window menu).
 +
 
 +
Position the new view over the top of an existing one:
 +
[[Image:PositionNewViewOnTop.png|600px|none]]
 +
 
 +
Drop the new view over the top of an existing one - the result is a stack:
 +
[[Image:DropNewViewOnTop.png|600px|none]]
 +
 
 +
Position the new view below an existing one:
 +
[[Image:PositionNewViewBelow.png|600px|none]]
 +
 
 +
Drop the new view below an existing one - the result is another split (surrounding views are resized to fit):
 +
[[Image:DropNewViewBelow.png|600px|none]]
 +
 
 +
== Human Readable Entity Names ==
 +
 
 +
Many ontologies use meaningless identifiers as the names of classes, properties and individuals. If your class hierarchy just looks like a mess of numbers or other computer-generated rubbish, but you have labels for each entity, you can ask Protege to use these labels instead.
 +
 
 +
# Select <span style="color:#B87A3D; font-weight:bold;">File | Preferences</span>.
 +
# Select the <span style="color:#B87A3D; font-weight:bold;">Renderer</span> tab of the preferences dialog.
 +
# Choose <span style="color:#B87A3D; font-weight:bold;">Render entities using annotation values</span>.
 +
# Where labels are provided, Protege will now display these in all views. If a label is missing it will continue to show the entity's ID.
 +
# The annotation that is getting used to render the label (as well as the language) can be selected by pressing the <span style="color:#B87A3D; font-weight:bold;">Annotations...</span> button.
 +
 
 +
The current renderer selected will be preserved next time you open Protege to save this step in the future.
 +
 
 +
Please also see this note about [[Protege4NamingAndRendering|naming and rendering of entities]].
 +
 
 +
[[Image:Render-labels.png|600px|none]]
 +
screenshot of entity rendering preferences
 +
 
 +
 
 +
== What Next? ==
 +
 
 +
To familiarize yourself more with the tool and its capabilities you could read through more of the [[Protege4UserDocs|Protege Desktop user documentation]].
  
All changes will be saved when Protege is properly shut down (or the save can be forced by selecting "Save current layout" in the Tabs menu).
+
Or try our fast and dirty guide to [[Protege4Pizzas10Minutes|building a pizza ontology in 10 minutes]].

Latest revision as of 19:25, May 23, 2016

Getting Started with Protege Desktop Editor

This page contains instructions for getting started with the Protege Desktop Ontology Editor. Applies to versions 4, 5 and newer.



Back to Protege Desktop User Documentation


Introduction

Protege is an OWL ontology development environment. This quick start guide forms part of the Protege Desktop user documentation and is designed to get you up and running with the tool.

In just a few minutes you should be able to install Protege, load an ontology, navigate around it, use a reasoner to classify it and configure the interface to your taste.

Download

If you haven't already done so, you need to download and install Protege Desktop from the Protege website: http://protege.stanford.edu/products.php#desktop-protege

Install & Run Protege

Please follow the step-by-step instructions to install Protege from [[Install_Protege5|here]. Basically, you just need to unzip the downloaded archive for your platform, and run either with one of the run scripts (run.bat, run.sh, run.command) or Protege.exe on Windows platforms.

Download the pizza ontology from: http://protege.stanford.edu/ontologies/pizza/pizza.owl (the unclassified version in XML/RDF syntax will work as an example).

Select Open OWL ontology from the Welcome screen and find the pizza.owl file on your filesystem.

Alternatively, you may also open the pizza.owl file directly from the Web: Start Protege, File menu -> Open from URL, and enter the URL: http://protege.stanford.edu/ontologies/pizza/pizza.owl

You will now be presented with the main Protege workspace, which opens by default to the Active Ontology tab. This tab shows an overview of the pizza ontology, including metrics on its contents, annotations about the ontology as a whole, and other imported ontologies (if any imports exist). The drop-down on the toolbar displays the currently active ontology, that is to say, the one into which all edits take place. When working on a single ontology this concept of the active ontology is not a concern.


screenshot of the active ontology tab in the protege-owl editor


Navigation

Now switch to the Entities Tab.

The Entities tab is the workhorse of the ontology editor. From this location, you can explore all of the classes, properties, and individuals in an ontology. As you may have already noticed, each tab is made up of several views which can be resized, removed, floated, split, and layered (more about views later). The selection model is global: when a class, property or individual is selected in the trees on the left-hand side, the right pane changes to display the selection immediately. In addition, most views implement hypertext navigation so that links can be followed easily regardless of which view you are using. Opening up the hierarchies and selecting a class or property displays the appropriate description on the right. Backward and forward navigation is possible with the left and right arrow buttons in the toolbar, which act just like a Web browser.


screenshot of the entities tab in the protege-owl editor


Another easy way to navigate around the contents of an ontology is to perform a search. The find box in the toolbar performs a global search over any named entity in an ontology. In addition, the hierarchy views have their own find dialogs (first, click anywhere in the view to give it focus, then Ctrl-F on Windows, Command-F on Mac).

Reasoning

Reasoning with your ontology is one of the most commonly performed activities and Protege comes with a built-in reasoner called HermiT. To classify your ontology, open the Reasoner menu and select HermiT, which will automatically classify your ontology. After the reasoner finishes classifying, an additional sub tab appears on the Entites tab to show the inferred class hierarchy. Unsatisfiable classes appear in red under Nothing and everything else appears in the hierarchy under their inferred superclasses. The asserted class hierarchy is still available, stacked under the asserted one.


screenshot of the inferred class hierarchy


There are other reasoners available for Protege, including Pellet and FaCT++. These reasoners are available for download from the File | Check for plugins... menu item.

Investigate other tabs

  • OWLViz - requires installation of Graphviz before anything will be visible. This tab shows a graphical representation of the class subsumption hierarchy. A full description of OWLViz is available in the OWLViz manual.
  • DL Query - requires the ontology to have been classified before it will return results. An arbitrary class description can be entered and the reasoner is queried for the sub/super classes, inferred members, etc., depending on what is selected.


Investigate views

Each tab is made up of multiple views - each with its own perspective on the ontology, or just one aspect of the ontology (like the last selected class).

Views can be stacked on top of each other, in which case you will see additional tabs for exposing them.

Examples of this are the usage views that are by default on the Entities, Classes, Properties and Individuals tabs. Select the tab to make the view visible.

screenshot of the usage view hidden behind the annotations view
screenshot of the usage view after selecting its tab

All of the views that are on tabs by default and many more that aren't are listed in the Views menu. You can add and remove views to create you own custom interfaces (see below).


Reconfigure the User Interface

Reconfiguring the user interface is easy! Adding and removing tabs and views is possible through the Tabs and View menus. Try removing the Classes and Properties tabs to unclutter the screen. Try adding a view to the Entities tab:

  1. Switch back to the Entities Tab
  2. Select a class to make sure the Selected Entity view is showing class views.
  3. Select Window | Views | Class Views | Asserted Superclass Hierarchy. Now, when you float over the editor, a blue outline shows where the new view will be dropped - either on top of, above, below, left, or right of each of the current views.
  4. When happy with the position, click the left mouse button to drop the view (if you want to cancel this operation just click somewhere on the toolbar instead).
  5. The superclass tree view is now visible (the tree shows the "upside-down" version of the subclass tree, using the current class as the root).

All changes will be saved when Protege is properly shut down (or the save can be forced by selecting "Save current layout" in the Window menu).

Position the new view over the top of an existing one:

PositionNewViewOnTop.png

Drop the new view over the top of an existing one - the result is a stack:

DropNewViewOnTop.png

Position the new view below an existing one:

PositionNewViewBelow.png

Drop the new view below an existing one - the result is another split (surrounding views are resized to fit):

DropNewViewBelow.png

Human Readable Entity Names

Many ontologies use meaningless identifiers as the names of classes, properties and individuals. If your class hierarchy just looks like a mess of numbers or other computer-generated rubbish, but you have labels for each entity, you can ask Protege to use these labels instead.

  1. Select File | Preferences.
  2. Select the Renderer tab of the preferences dialog.
  3. Choose Render entities using annotation values.
  4. Where labels are provided, Protege will now display these in all views. If a label is missing it will continue to show the entity's ID.
  5. The annotation that is getting used to render the label (as well as the language) can be selected by pressing the Annotations... button.

The current renderer selected will be preserved next time you open Protege to save this step in the future.

Please also see this note about naming and rendering of entities.

Render-labels.png

screenshot of entity rendering preferences


What Next?

To familiarize yourself more with the tool and its capabilities you could read through more of the Protege Desktop user documentation.

Or try our fast and dirty guide to building a pizza ontology in 10 minutes.