Status
in draft
What is UQAM-DEV?
UQAM-DEV is an execution and development environment for VIVO.
- See also : What is UQAM-DEV?
Requirements
All the tools necessary for VIVO development – such as Maven, GIT, code editor, ontology engineering and editing, etc. – are directly integrated into the Eclipse environment.
It is therefore not necessary to install those tools on your platforms, unless you want to use them outside of Eclipse.
1 Installing TopBraid Composer
This release (Rev 4) is based on the TopBraid Composer (TBC) software. TBC is an ontological engineering tool. It allows ontology editing, the aggregation of several ontologies and the representation of ontology content in a visual form. UQAM-DEV Rev.4 is based on the technology of this tool.
The installation of UQAM-DEV starts with the download of TBC Free Edition which is available from this link:
https://www.topquadrant.com/topbraid-composer-install/
Download and install the right version for your operating system
2 Installing UQAM-DEV
You can continue the installation of UQAM-DEV by following these steps:
| Step | Description |
|---|---|
2.1 Unzip and launch TopBraid ComposerIn your favorite directory (ex.: in my case |
By default, TopBraid will ask you to select a workspace. The actual location of that workspace has little importance. You can locate it wherever you want, choose to use it as default if desired, and proceed.
Topbraid will then display a general information window. Dismiss it to get to main interface:
|
2.2 Installing UQAM-DEV with TopBraid Installing New SoftwareUnder Help Menu, Select Install New Software |
|
2.3 Adding Software SiteFrom the Available Software window, enter http://vivo-i18n.dev.uqam.ca:8080/uqam-dev/rev410/ in the Work With Field and 'Select All' check box Then click on the 'Next' button. |
|
2.4 Complete the installationAnswer positively to all the questions and finalize the installation by clicking on Finish. The following dialogue should appear and you just have to wait a little while until the process is complete. You will be asked security questions, you must accept them by clicking on the OK button. At the end of the installation, you will be offered to restart Eclipse. Click 'Yes'. |
|
2.5 Complete the configurationFor this configuration step, Eclipse will restart twice. You will therefore see those two splash screens appear before you can access your workspace. |
|
3 Testing the installation
Here are a few checks that will help ensure that UQAM-DEV is correctly configured.
| Check | Description |
|---|---|
3.1 Perspectives and projectsAfter the UQAM-DEV has been installed:
The list of projects should appear as shown in the second image. |
|
3.2 Project ContentsEach project starting with a number contains a list of files needed to run VIVO. Make sure that the files that are part of your installation look like the figure shown here. |
|
3.3 Setup External ToolsThis step completes and validates the installation of the external tools that are ready to be configured in UQAM-DEV.
|
|
3.4 Setup Run ConfigurationsThis step completes and validates the installation of the run tools that are ready to be configured in UQAM-DEV. In 1) scroll down the menu corresponding to the Run button, and choose Organize Favorites... In 2) in the dialog box that will appear, click on 'Add', then 'Select All', then 'OK' and 'OK'. In 3) by clicking the Run button again you should see the list of shortcuts allowing you to perform the actions necessary to compile VIVO. | 1)
2)
3)
|
3.5 Validating Servers installationWith the file manager, access the directory containing Eclipse. Observe in this directory if the four servers are present as shown in the figure. |
|
Conclusion
At the end of this procedure you should have a complete installation of the UQAM-DEV. You can refer to the other documents in this wiki to learn how to compile and run a VIVO instance.
Appendix
List of useful links
| Name | URL |
|---|---|
| UQAM-DEV Rev 4 updateSite | http://vivo-i18n.dev.uqam.ca:8080/uqam-dev/rev410/ |