Download requirements

In this section you will find the list of softwares and libraries that are required to use the full capabilities of the Osmose model.

Download Java

Since the Osmose numerical core is coded in Java, let us clarify some of the acronyms related to the Java technologies.

• JVM: Java Virtual Machine. This is a set of software programs that interprets the Java byte code.

• JRE: Java Runtime Environment. This is a kit distributed by Sun for running Java programs. A JRE provides a JVM and some basic Java libraries. A JRE is required to run Osmose.

• JDK or SDK: Java (or Software) Development Kit used by the programmer. It provides a JRE, a compiler, useful programs, examples and the source of the API (Application Programming Interface: some standard libraries). A JDK is required if the precompiled Java binaries are not used

We strongly recommend the OpenJDK suite, available from https://jdk.java.net/ :

• Download the archive file (.tar.gz for .zip extension).
• Extract the files to a dedicated folder.
• Set the JAVA_HOME environment variable to the location of the Java folder.

[!TIP] To find out how to set environment variables in Windows, click here. For Linux/Mac Os users, click here

[!WARNING] The OpenJDK version must be at least 8

Installing NetCDF library

As Osmose makes extensive use of NetCDF files, the NetCDF4 library must be installed.

Mac Os X

To install the library on a Mac OS system, open a terminal and type:

sudo port install netcdf4

Linux

To install the library on a Linux system, open a terminal and type:

sudo apt install netcdf4

Windows

Download and install the NetCDF library from the Unidata website. Select the netCDFX.Y.Z-NC4-DAP-64.exe install.

[!WARNING] Ensure that the NetCDF binaries are added to the PATH environment variable.

Download R

The Osmose Java core is embedded in an Osmose R package, which allows pre-processing, calibration, execution and post-processing of Osmose configurations. It is strongly recommended to install R to take advantage of the features provided by the R package.

Download instructions for R are available for Windows, Linux and Mac Os X.

It is also recommended that you install the RStudio GUI (https://rstudio.com/).

[!NOTE] If you do not intend to use the R package, you can skip this part.

Installing R libraries

To install the Osmose package, R libraries are required (see the DESCRIPTION file). These libraries can be installed by typing from an R console:

install.packages(c("calibrar", "knitr", "ncdf4", "rlist",
                   "rmarkdown", "stringr", "fields",
                   "R.utils"))