...
Info | ||
---|---|---|
| ||
in draft |
Sommaire |
---|
0. What is UQAM DEV?
UQAM DEV is an execution and developpement environnement for VIVO.
- See also : What is UQAM-DEV?
1. Requirements
All the tools necessary for VIVO development – such as Maven, GIT, code editor, 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.1 Eclipse IDE Neon 3 for J2EE Developers
The neon-3 version is required for compatibility with the Topbraid Composer Composer Free Edition Ontology Editor.
Follow the link below to install the J2EE developer version of eclipse for the desired platform. In this demonstration we will be using the 64-bit version of Linux.
For further information, you can read the Eclipse platform overview.
1.2 Java JDK
En An essential prerequisite for the operation of UQAM-DEV is the installation of Java . The command below presents its installation in the Linux environment.
...
JDK, version 8.
- Linux (Ubuntu) environment :
sudo apt install openjdk-8-jdk
- Windows : see https://www.oracle.com/java/technologies/javase-downloads.html#javasejdk
- MacIntosh : see https://docs.oracle.com/javase/9/install/installation-jdk-and-jre-macos.htm
1.3 Setting-up Eclipse ini file
Some parameters must be changed in $ECLIPSE_HOME/eclipse.ini.
Under Ubuntu, replace the vmargs parameters with:
Bloc de code |
---|
-vmargs
--add-modules=ALL-SYSTEM
-Dsun.jnu.encoding=UTF-8
-Dfile.encoding=UTF-8
-Dosgi.requiredJavaVersion=1.8
-Dosgi.dataAreaRequiresExplicitInit=true
-Dosgi.instance.area.default=@user.home/eclipse-workspace
-XX:+UseG1GC
-XX:+UseStringDeduplication
-Xmx4096M
-Xms640M
-XX:SurvivorRatio=16
-XX:NewRatio=3 |
Under Windows, you should as well add a vm parameter, providing the path to your Java bin directory:
Bloc de code |
---|
-vm
C:\Program Files\Java\jdk1.8.0_171\bin |
1.4 Linux xrdp (optional for Windows Remote Desktop)
This optional prerequisite requirement may be useful for developers who wish to connect to a Linux Desktop via the Windows Remote Desktop.
Bloc de code |
---|
sudo apt install openjdk-8-jdk
java -version |
...
.
...
Bloc de code |
---|
sudo apt -y install xrdp tigervnc-standalone-server sudo systemctl enable xrdp |
1.4 Other tools
...
1.5 Knowing the basic information about eclipse IDE
2 Installing UQAM-DEV
Step | Description | ||
---|---|---|---|
2.1Unzip and launch EclipseIn your favorite directory, unzip the Eclipse package and click on the executable to launch the application.
| By default, Eclipse will ask you to select a workplace. The actual location of that workplace has little importance. You can locate it wherever you want, choose to use it as default if desired, and proceed. Eclipse will then display a general information window. Dismiss it to get to Eclipse main interface:Eclipse appearance after choosing the workspace and closing the welcome window. | ||
2.2 Eclipse Installing new SoftwareUnder Help MenueMenu, Select Install New Software | |||
2.3 AddingUQAM-DEVSoftware SiteFrom the Available Software window, click on the Available Software Sites link to bring up the preference window. Then click on the add button. | |||
2.4 Assignthe URL ofUQAM-DEVAfter having assigned the name and location of the archive, click OK and then OK again in the preference window. SoftwareIn the Add Site form, provide the following name and URL: UQAM-DEV UQAM-DEV URL = http://vivo-i18n.dev.uqam.ca:8080/uqam-dev/release/ Then click OK and then OK again in the preference window. | |||
2.5 Select UQAM-DEV in Available Software WindowsIf UQAM-DEV fails to appear in the dropdown menu, you may refresh it by clicking Cancel, and selecting again the menu Install New Software as in step 2.2. | |||
2.6 Select the desired featuresAfter a few seconds of waiting, you will be able to choose Eclipse will display the features that are most convenient for you. After the sectionSelect them, and click on the Next button. | |||
2.7 Complete the installationAnswer positively to all the questions you are asked and then, finalize the installation by clicking on the Finish button. 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, eclipse you will offer you to reboot. Accept the proposal by clicking on the Yes buttonbe offered to restart Eclipse. Click Yes. | |||
2.8 Complete the configurationFor this configuration step, eclipse Eclipse will restart twice. You will therefore see this those two splash screens appear two times before you can access your workspace. |
3 Testing installation
Here are a few observations that will help ensure that UQAM-DEV is correctly configured
Observation | Description |
---|---|
1) Perspectives andProjectsprojectsAfter the UQAM-DEV has been installed, the list of perspectives should appear as shown in the red circle at the top right. If the Java perspective is selected, then the list of projects will :
The list of projects should appear as shown in the red circle on the left side of the figuresecond image. | |
2) Project ContentsFor each Each project starting with a number , contains a list of files needed to use run VIVO is presented. Make sure that the files that are part of your installation look like the figure shown here | |
3) Setup External ToolsThis step completes and validates the installation of the external tools that are ready to be configured in UQAM-DEV.In 1)
| 1) 2) 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) |
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. |
...
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 link
Name | URL |
---|---|
UQAM-DEV updateSite | http://vivo-i18n.dev.uqam.ca:8080/uqam-dev/release/ |