Skip to content

OpenFLUID/openfluid

develop
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
doc
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

About OpenFLUID

OpenFLUID is a software environment for spatial modelling in landscapes. Based on an explicit representation of spatial objects and their interactions, OpenFLUID is designed for modelling dynamics at different spatial and temporal scales. It provides functionalities for the development and integration of computational codes, model coupling, parameterization and execution of simulations. It is also a collaborative framework for the capitalization and sharing of multi-disciplinary scientific models.
OpenFLUID has already been applied in various contexts: hydrology, diffuse pollution, agricultural practices, erosion, land use planning, etc. Free, open-source and based on open standards, OpenFLUID is fully commited to open and reproducible science approaches.

Builder screenshot

Features

  • 🚀 Performance oriented simulation engine
  • 👩‍💻 Open architecture to plug your own simulation models
  • 🗂️ Extensible output formats through plugins
  • 🖥️ User friendly software environment for development and integration of models
  • ⌨️ Command line interface
  • 📚 Integrated documentation system for models
  • 🤝 Collaborative system to store and share models source codes

Built with

OpenFLUID relies on several tools and libraries

  • C++17
  • Boost for low-level structures
  • GDAL for geospatial data I/O and management
  • JSON for metadata and settings I/O
  • TinyXML for datasets I/O
  • libcurl for network operations
  • Qt5 for UI framework and applications
  • CMake for build/test/packaging configuration and management
  • Doxygen for technical documentation

Getting started

Installation

OpenFLUID is available for Linux, MacOS and Windows. You can download it from the official web site.

Once the installation has been performed using instructions below according to the operating system, open a terminal (Linux, MacOS) or a command prompt (Windows) an type openfluid version to check if the installation is successful.
The OpenFLUID version is displayed if it is correctly installed.

Command line version

Linux

  1. Download the package corresponding to the Linux distribution
  2. Open a terminal
  3. Use the dedicated package installer tool

Ubuntu/Debian

sudo apt install /path/to/<openfluidpackagfile>.deb

Fedora

sudo dnf install /path/to/<openfluidpackagfile>.rpm

MacOS

  1. Install Brew if not already present (see also https://brew.sh/)
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  1. Add OpenFLUID tap for Brew
brew tap OpenFLUID/openfluid
  1. Install OpenFLUID using Brew (with --no-quarantine option to avoid Gatekeeper restrictions in recent MacOS versions)
brew cask install --no-quarantine openfluid

Windows

  1. Download the OpenFLUID installer
  2. Download the OpenFLUID additional tools installer
  3. Execute the OpenFLUID installer (optional but recommended)
  4. Execute the OpenFLUID additional tools installer (optional but recommended)

Additional information is available on the OpenFLUID Community site

From sources

Detailed instructions for build and installation from sources are available on the OpenFLUID Community site.

Manuals and Trainings

The OpenFLUID manual and the training sessions docs are available online.
(the training sessions documents are in french 🇫🇷)

Resources

Authors and License

OpenFLUID is developed at LISAH (Montpellier, France), a research joint unit on interactions between soil, agrosystems and hydrosystems. It is actively supported by the INRAE research institute on agriculture, environment and food.

See the AUTHORS.md file for details about the developers.

OpenFLUID is distributed as a free and open-source software. See the LICENSE file for details.

Contact

To contact us, see the OpenFLUID team page.
You can also join the OpenFLUID slack workspace. Ask the team for an invitation link.