-
Notifications
You must be signed in to change notification settings - Fork 2
Installation
OntoPilot is mostly self-contained and has few software installation dependencies. The only required software is the Java run-time environment, and there is a very good chance your computer already has Java installed (many popular software programs also require it). It is easy to check if your computer has Java installed and install it, if needed.
Although it is not required by OntoPilot, I recommend that you also install and use Protégé, a powerful GUI-based tool for working with ontologies.
Begin by deciding where on your system you'd like to install OntoPilot. Once you've chosen a location, you can install OntoPilot in one of two ways. First, you can use git to install OntoPilot, as follows. (Note the first command, in which /path/to/installation/location should be replaced with the path to your chosen installation location.)
$ cd /path/to/installation/location
$ git clone https://github.com/stuckyb/ontopilot.git
Or, you can download the OntoPilot zip archive and expand it in your chosen installation location.
Once you've downloaded OntoPilot to your local file system, try running OntoPilot to make sure everything is working. If you are on Windows, run
C:\> path\to\installation\location\ontopilot\bin\ontopilot.bat -h
(The example command above assumes you are at the root of the C drive.)
If you are on GNU/Linux or MacOS, run
$ /path/to/installation/location/ontopilot/bin/ontopilot -h
If successful, OntoPilot should print a bunch of help information to the terminal window and then quit.
After installing OntoPilot, you can optionally set your search path to include OntoPilot's executable program. This is very handy because it allows you to run OntoPilot like any other terminal command, without needing to type the path to the installation location. The OntoPilot executables are located in the directory /path/to/installation/location/ontopilot/bin, so you will need to add this directory to your search path. On all major PC operating systems (GNU/Linux, Windows, and OSX), the search path is controlled by the value of an environment variable called PATH that contains a list of directories; you will need to add /path/to/installation/location/ontopilot/bin to this list. So, for example, if you installed OntoPilot in the directory /opt, then you would add /opt/ontopilot/bin to your search path. If you are unsure about how to do this, see these detailed instructions (if you use OSX, follow the directions for Solaris and Linux).
Note that modifying your search path is completely optional, but if you choose not to add OntoPilot to your search path then you will need to specify the full path to OntoPilot's location every time you run OntoPilot. This quickly gets annoying, so it is probably easiest to just update your search path. All of the example commands in the rest of the user documentation will assume that OntoPilot's install location has been added to the system search path.