Running Wandora
(→Execution rights in Linux and MacOS) |
(→Wandora's shell scripts) |
||
| (25 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | This chapter expects that you have already successfully [[How to install Wandora|installed Wandora]]. Ready to run Wandora application. If your | + | This chapter expects that you have already successfully [[How to install Wandora|installed Wandora]]. Ready to run Wandora application. First, check [[System requirements|system requirements]]. If your system is suitable for Wandora, browse shell scripts in '''bin''' directory and choose the script for your memory footprint. |
To get your hands dirty you might want to try example projects found in samples folder. If you are not familiar with the Wandora I suggest you take a look at the [[Quickstart]]. Wandora documentation is [[Documentation|here]]. | To get your hands dirty you might want to try example projects found in samples folder. If you are not familiar with the Wandora I suggest you take a look at the [[Quickstart]]. Wandora documentation is [[Documentation|here]]. | ||
| Line 9: | Line 9: | ||
== Wandora's shell scripts == | == Wandora's shell scripts == | ||
| − | + | Wandora startup scripts locate in '''bin''' directory. By default the '''bin''' contains several '''bat''' and '''sh''' scripts. '''Bat''' scripts are for Windows based operating systems while '''sh''' scripts are used in Linux and Unix type platforms. | |
| − | * '''SetClasspath''' contains all classpath settings of Wandora. | + | * '''SetClasspath''' contains all classpath settings of Wandora. You should not execute this script directly. |
| − | * ''' | + | * '''SetR''' contains all required settings for R language environment. You should not execute this script directly. If you want to use R environment with the Wandora application, you should check the settings in the SetR. |
| − | * '''Wandora- | + | * '''SetProcessing''' contains all required settings for Processing integration. You should not execute this script directly. If you want to use Processing in the Wandora application, you should check the settings in the SetProcessing. |
| − | * '''Wandora- | + | * '''SetTesseract''' is used to initialize all settings of the Tesseract OCR engine. You should not execute this script directly. Check the settings in the file if you are using the Tesseract OCR engine. |
| − | * '''Wandora- | + | * '''Wandora''' sets JRE's memory to 1G and runs Wandora. This is the default script used to start Wandora application. Also, it executes all helper scripts described above. |
| + | * '''Wandora-4g''' sets JRE's memory to 3G and runs Wandora. Script is targeted to 64 bit operating systems with a memory size of 4G at least. | ||
| + | * '''Wandora-8g''' sets JRE's memory to 7G and runs Wandora. Script is targeted to 64 bit operating systems with a memory size of 8G at least. | ||
| + | * '''Wandora-16g''' sets JRE's memory to 12G and runs Wandora. Script is targeted to 64 bit operating systems with a memory size of 16G at least. | ||
| − | + | If your operating system is not Windows or Linux or Unix you may need to customize scripts before successful execution of Wandora is possible. See also [[Tuning Wandora for Mac OS]] if your operating system is OSX. | |
| − | Running a shell script with memory settings beyond your physical memory ends up the Java refusing to start the application | + | Running a shell script with memory settings beyond your physical memory ends up the Java refusing to start the application. You should always use a script with memory settings lower than your physical memory. |
== Execution rights in Linux and MacOS == | == Execution rights in Linux and MacOS == | ||
| − | We are developing Wandora in Windows. As a consequence shell scripts used to run Wandora application may have invalid execution rights. To make Wandora's shell script runnable in Linux you have to change it's execution rights with | + | We are developing Wandora in Windows. As a consequence shell scripts used to run Wandora application may have invalid execution rights. To make Wandora's shell script runnable in Linux you have to change it's execution rights with a command: |
chmod a+x Wandora.sh | chmod a+x Wandora.sh | ||
| Line 32: | Line 35: | ||
./Wandora.sh | ./Wandora.sh | ||
| − | Notice, your current directory must be '''bin'''. | + | Notice, your current directory must be '''bin'''. If you are a Mac OS user, please read also chapter [[Tuning Wandora for Mac OS]]. |
== Command parameters == | == Command parameters == | ||
| Line 52: | Line 55: | ||
java -classpath %WANDORACLASSES% org.wandora.application.Wandora | java -classpath %WANDORACLASSES% org.wandora.application.Wandora | ||
| − | contains no path prefix. Command refers to the first Java version found in your computer system. Sometimes, when you have multiple Java virtual machine installations, the command may refer to older | + | contains no path prefix. Command refers to the first Java version found in your computer system. Sometimes, when you have multiple Java virtual machine installations, the command may refer to older Java version. This causes the Wandora execution to fail. To check which Java runtime environment the command refers you may use command |
java -version | java -version | ||
| − | If Java refers to older version, you should tweak general path settings of | + | If Java refers to older version, you should tweak general path settings of your computer or adjust Wandora's startup scripts. You could add absolute path for the Java 8 in front of the Java command, for example. |
| + | |||
| + | |||
| + | __NOTOC__ | ||
Latest revision as of 15:26, 10 May 2016
This chapter expects that you have already successfully installed Wandora. Ready to run Wandora application. First, check system requirements. If your system is suitable for Wandora, browse shell scripts in bin directory and choose the script for your memory footprint.
To get your hands dirty you might want to try example projects found in samples folder. If you are not familiar with the Wandora I suggest you take a look at the Quickstart. Wandora documentation is here.
[edit] Wandora's shell scripts
Wandora startup scripts locate in bin directory. By default the bin contains several bat and sh scripts. Bat scripts are for Windows based operating systems while sh scripts are used in Linux and Unix type platforms.
- SetClasspath contains all classpath settings of Wandora. You should not execute this script directly.
- SetR contains all required settings for R language environment. You should not execute this script directly. If you want to use R environment with the Wandora application, you should check the settings in the SetR.
- SetProcessing contains all required settings for Processing integration. You should not execute this script directly. If you want to use Processing in the Wandora application, you should check the settings in the SetProcessing.
- SetTesseract is used to initialize all settings of the Tesseract OCR engine. You should not execute this script directly. Check the settings in the file if you are using the Tesseract OCR engine.
- Wandora sets JRE's memory to 1G and runs Wandora. This is the default script used to start Wandora application. Also, it executes all helper scripts described above.
- Wandora-4g sets JRE's memory to 3G and runs Wandora. Script is targeted to 64 bit operating systems with a memory size of 4G at least.
- Wandora-8g sets JRE's memory to 7G and runs Wandora. Script is targeted to 64 bit operating systems with a memory size of 8G at least.
- Wandora-16g sets JRE's memory to 12G and runs Wandora. Script is targeted to 64 bit operating systems with a memory size of 16G at least.
If your operating system is not Windows or Linux or Unix you may need to customize scripts before successful execution of Wandora is possible. See also Tuning Wandora for Mac OS if your operating system is OSX.
Running a shell script with memory settings beyond your physical memory ends up the Java refusing to start the application. You should always use a script with memory settings lower than your physical memory.
[edit] Execution rights in Linux and MacOS
We are developing Wandora in Windows. As a consequence shell scripts used to run Wandora application may have invalid execution rights. To make Wandora's shell script runnable in Linux you have to change it's execution rights with a command:
chmod a+x Wandora.sh
Then you can execute the script with commands
cd ./bin ./Wandora.sh
Notice, your current directory must be bin. If you are a Mac OS user, please read also chapter Tuning Wandora for Mac OS.
[edit] Command parameters
Wandora eventually runs with Java command
java -classpath %WANDORACLASSES% org.wandora.application.Wandora
where %WANDORACLASSES% (or $WANDORACLASSES) is a shell variable defining all class paths for Wandora. Java class org.wandora.application.Wandora builds the main frame of the application. It also supports command parameters. You may attach XTM, LTM, RDF, N3 or WPR (Wandora project file) document name as a command parameter to the run command to load the document at startup. For example
java -classpath %WANDORACLASSES% org.wandora.application.Wandora my_topicmap.xtm
imports XTM document my_topicmap.xtm to Wandora at startup.
[edit] Multiple JREs
Notice the used Java command
java -classpath %WANDORACLASSES% org.wandora.application.Wandora
contains no path prefix. Command refers to the first Java version found in your computer system. Sometimes, when you have multiple Java virtual machine installations, the command may refer to older Java version. This causes the Wandora execution to fail. To check which Java runtime environment the command refers you may use command
java -version
If Java refers to older version, you should tweak general path settings of your computer or adjust Wandora's startup scripts. You could add absolute path for the Java 8 in front of the Java command, for example.
