OpenKnoME is the cornerstone application used by our knowledge engineers, and it is provided here by topThing as an open-source resource to the clinical terminology community. Custom extensions and support services are additionally available as required. The software is made available under the terms of the topThing Open Source License (TOSL)
In addition to the topThing software, OpenKnoME requires two pieces of closed source 3rd party software to function:
OpenKnoME is currently available for Microsoft Windows platforms only. It is not technically difficult to port VisualWorks applications to other platforms, and we hope to do so eventually (when funds permit).
Current version: 5.4 May 2002
NB Version 5.4 has different installation routine from previous distributions
OpenKnoME is an OpenGALEN compliant client application. It isn't a lot of use without a server to talk to.
Before installing the OpenKnoME, you will need to obtain and install an OpenGALEN compliant terminology server. We suggest the Kermanog one, based on their ROIS product. Follow this link, and then the link to download the current version of their 'Demo-GCE' software package. This software includes a fully functioning OpenGALEN terminology server, and some of Kermanog's own client software applications.
NB The Kermanog Demo-GCE package requires a license key to operate. Instructions of how to get one are on the same page at the Kermanog site.
The OpenKnoME software itself is distributed as a zipped archive of files that need manual installation. We used to have an automatic installer, but we found it more trouble than it was worth.
STEP 1: To intall OpenKnoME, unzip the contents of the archive onto your hard disk. The software will create a directory called 'openknome' below the point you choose to install it, and all the software will be in that new directory or a subdirectory of it. Normally, therefore, we would choose to unzip the archive into the root directory of a hard disk (e.g. into c:\) so that a new first level directory called 'openknome' is created, with all the files below that.
STEP 2: Locate, and open, the file openknomeXXx.im (where XXx is the version number), using the 'open with..' option that you can get by pointing at the file, pressing the RIGHT mouse button, and selecting 'Open With..' from the popup menu.
STEP 3: In the Open With dialogue that appears, press the 'Other...' button. Locate the directory in which the openknomeXXx.im file was extracted, and choose the file visual.exe. Ensure you check the 'Always use this program to open these files' option in the Open With dialogue.
STEP 4: the OpenKnoME software should now start and will enter a one-time self configuration routine type thingy.
First, You should see a CinCom splash and license screen, and then this should appear:

If this doesn't happen, or you get any error messages along the way, contact us.
Assuming this does happen successfullly, first of all, identify yourself: type a user name. OpenKnoME supports collaborative ontology development, so it needs to know who you are.
Press the tab key to move the focus out of the text box. The start button (previously greyed out) should now become enabled. Now press or click on the start button.
OpenKnoME will now ask you if you want to continue the local installation. Choose 'Yes'. During the configuration, OpenKNOME will try to make contact with the Kermanog server that you should already have obtained and installed. If you have, OpenKNOME should find it without your help, but if for some reason it can't it may ask you to show it where the Kermanog installation directory is. If this happens, use the dialogue that appears to navigate to the directory where the rois.exe file is located. This will be the base directory into which you told the Kermanog installer to install its software.
During self configuration, OpenKnome writes a file called install.log which you should mail to us with any support questions in the event of a failed installation.
You should eventually get to this console:

This is the main KnoME Pro console. If this appears (with no error messages), it means that you've got the OpenKnoME client and the Kermanog server talking to each other. From here you can access all the tools and components that make up the OpenKnoME environment.
Tip: in the event that you have followed the instructions above, but it doesn't work, try the following: copy the openknome.im file into the same directory as the ROIS.exe file, and also copy the files under /openknome/system into the rois/system directory and then try running this new copy of the openknome software. If this works, see also the section on setting the project directories.
OpenKnoME is a very large, complex and extremely powerful ontological engineering environment which has matured over more than 10 years of research and development. We are open sourcing it now in order to enable and encourage the further growth of the community of OpenGALEN ontology developers, but we would also be happy to hear from people who want to use it for ontological work in other domains. However, given our OpenGALEN focus, most of what follows assumes that you want to use OpenKnoME to find out more about OpenGALEN and especially about the OpenGALEN Common Reference Model.
There is some user documentation and a GRAIL tutorial installed in a directory under your OpenKnoME installation directory, though note that some of the screenshots may be taken from earlier incarnations of the software.
To exit the application completely, return to this KnoME Pro console and select menu option: Knome..Exit. Then select 'Exit without saving'.
An important function of the KnoME software is to manage or access the OpenGALEN Common Reference Model - both in its compiled form and, obviously, as the ASCII source code files from which the compiled form is actually constructed. This offers some scope for confusion: when the KnoME says 'model' does it mean the compiled data structure (which sits inside an OpenGALEN terminology server, accessed across the API) or does it mean the ASCII sources which are managed by the KnoME ?
The ASCII sources are usually designated a GRAIL source model. These can be opened from the Knome.. drop down menu on the console.
The compiled model is a GRAIL model, or just a model. These can be opened from the Model.. drop down menu on the console.
Select Model..Open model..By Type..Grail
A list of available precompiled GRAIL models - that can be opened by the server - should appear. If they do not, you probably customised your installation directory. The KnoME only looks for models in a specific project . The currently active project ident, and the location of the XML file listing the available idents and their association directory locations, can be found under Special..Options..Server..ROIS
Either: select Browsing..Browse Knowledge, or click on the third icon from the left (like a magnifying glass)
Enter the knowledge name for the concept you want to browse. If you're looking at one of the OpenGALEN Common Reference Models, we would suggest that interesting places to look at include:
BodySystemAnatomy
BodySystemPathology
Sign
Symptom
Device
ActiveDrugIngredient
For further instructions or guidance about how to browse the concept model, try the available documentation that was included in the OpenKnoME package you downloaded, or the tutorial/help file that comes with the the Kermanog package (a CHM file). In most cases, if you think you should be able to do it, you can. If you get really stuck, contact us.
OK - so you've got a compiled model open and managed to browse it. You've worked out how to move up and down the hierarchy, how to spawn loads of new browsers off an existing one, how to see the definition of a non-primitve concept, how to get the list of necessary statements or sensible sanctions attached to a concept etc etc.
But where does this knowledge come from ? How is it authored ?
Current full ASCII sources for the OpenGALEN CRM are available here. A version may come bundled with the software packages you just installed.
Note: OpenGALEN distributes the CRM sources in a format that requires conversion into a format specific to the KnoME, to make them useful for editing and browsing in that particular environment. If you have obtained the source in the distribution format, and want to convert them, see here for details of how to import OpenGALEN sources into the KnoME environment.
An important part of OpenKnoME is the GRAIL source code editing and compiling environment. This is embodied in a tool called a Source Unit Controller. To get one of these, from the OpenKnoME console, select KnoME..Open Grail Source Model. You should see this dialogue:

If you have a set of source files already in the correct OpenKnoME format, then you should see it listed in the window (in the screenshot above, OpenKnoME has found one set of sources in the right format). If you have a set of sources, but they don't appear in the list, then select Change Directory and point the OpenKnoME at the directory below which you placed your sources. There will be a file with the extension BOS in this directory. Once you have your sources listed, select them and press OK. You will now get a new tool (a Source Unit Controller) that looks like this:

Alternatively, if you don't have any sources already in the right format, then either the list in the 'Choose which model to edit' dialogue above will be empty, or it will contain some source file names, but not the one you want. In this case, you are going to have to import a set of distribution format files, probably the CRM from OpenGALEN. To do this, you must first open a new 'container' for the result of this import.
From the OpenKnoME console, select KnoME..Open Grail Source Model. In the dialogue that appears (see earlier for an example) press the Create new model button and, in the next dialogue, give a name to your model sources. You will now get a Source Unit Controller, except the window will only contain one entry: untitled. This entire window is a blank GRAIL source container, containing one unit only which, so far, nobody has given a name to and which also contains no GRAIL code. If you wanted to build a completely new GRAIL model, unrelated to the OpenGALEN CRM, this is what you would start with.
Assuming you now want to import some external distribution format GRAIL files - such as the OpenGALEN CRM distribution, select Source..Import..Exported Model..Exported Directory from the Source Unit Controller menu and then supply the location of the directory in which the OpenGALEN CRM distribution files have been placed. Wait a while.
A typical OpenGALEN CRM release is comprised of some 1300 separate ASCII files - called source units - many of which are very small. The OpenGALEN distribution format is fine for compiling, but not for humans to browse and edit.
The Source Unit Controller displays the source units in a monoaxial hierarchy, for easy browsing and editing. All Source Unit Controller hierarchies are manually declared by the authors of the files, at the time they were written. They are NOT computed from the sources, and the hierarchy of the sources has absolutely no relationship to the hierarchy of the concepts referred to in the sources.
You can drag and drop files around the hierarchy and also add new units. Note, however, that GRAIL compilation is dependent on source order. The hierarchy also serves to declare the order in which files are supposed to be compiled, so moving files around the hierarchy may very well result in a set of sources that no longer compiles.
In the source unit controller, model source units appear in various colours. You can always inspect the contents of a unit, but the colour tells you who has the right to save changes to it. This is important in a collaborative modelling environment, where more than one knowledge author might be working on the sources simultaneously. Green means you (and only you) can save changes to that unit. Black means nobody can (but anybody can ask for permission). Any other colour means somebody else has write permission, and so must surrender that permission before you can have it.
To expand and collapse the hierarchy of sources, double click on a unit. For example, double click on the Medical Extensions line and you'll see something like:

You can carry on drilling down the source unit hierarchy, for example through :
Medical Extensions
...Basic Medical Science
....Anatomy
......Sensory
........Anatomy of Eye
If you now double click on Anatomy of Eye, because there are no more levels in the source unit hierarchy, the source unit controller will instead open that unit for reading and editing. A source unit editor tool will open:

If you want to browse or edit a source unit that isn't a leaf node in the source unit hierarchy, highlight it and (from the right mouse button pop-up menu) select Edit Unit.
The source unit editor tool allows you to read the GRAIL code, edit it (and save it if you have permission to alter the unit), write comments or view the log file. You can also highlight concepts in the GRAIL code text, and then ask to browse that concept in the compiled model. So, for example, double click your mouse on the first word 'Eye' in the source text. It will highlight. Now, with the mouse hovering over the source code pane, press your mouse middle button. The following pop-up menu will appear:

Select Browse Results. A concept browser tool,centred on the concept [Eye], will appear:

If you get this far: congratulations. If you'd like to know how to dig deeper, contact us and we'll try to respond by expanding this user guide.