Repository navigation
Software Components
This page introduces the main software components used to work with OSMOSE. OSMOSE should be understood as a modelling platform, not only as the core model simulator. In current stable versions, the core simulator is implemented in Java, while the R package provides the main user interface for installing OSMOSE, preparing inputs, running simulations, reading outputs, analysing results, plotting indicators, and supporting calibration workflows.
For most users, installing and using OSMOSE means installing the R package and having Java available on the system. The R package is distributed with the Java code and the .jar files of stable OSMOSE versions, including the current version. Therefore, new users who start from the demos generally do not need to compile the Java code.
The distinction between the core simulator and the R package is important because some OSMOSE workflows involve pre-processing steps that are carried out in R before the core simulator is executed. Similarly, most post-processing, plotting, and output analysis are performed through R tools.
-
Overview
Provides a general description of the OSMOSE software ecosystem and explains how the different components interact. -
Core simulator
Describes the role of the executable simulation engine. The current core simulator is implemented in Java, but the concept of a core simulator is independent of the programming language used internally. -
R package
Introduces the OSMOSE R package as the main user-facing tool for installing OSMOSE, managing workflows, preparing inputs, running simulations, and analysing outputs. -
Input pre-processing
Explains the pre-processing steps that may be handled by the R package before running the core simulator, including the preparation or transformation of input files. -
Running simulations
Describes how simulations are launched, controlled, and monitored through the available OSMOSE tools. -
Reading outputs
Explains how OSMOSE outputs are read after a simulation, especially through the R package. -
Analysing and plotting results
Describes the tools used to analyse simulation results, compute indicators, and generate plots.
For regular users, the recommended workflow is based on the stable OSMOSE R package and the stable Java .jar files distributed with it. This is the pathway used for standard installations, demos, and most model applications.
Development workflows are different. They may involve the Java source code, Maven, compilation steps, or testing versions that are not yet distributed as stable releases. These topics are documented separately under Development and Contribution.
Users who are new to OSMOSE should first read Model Overview to understand the basic modelling concepts, then use this page to understand how the software components fit together.
After this page, users preparing a model configuration should continue with Inputs and Configuration. Users who want to run an existing configuration can go directly to Running simulations or Run an existing configuration.