Skip to content
Ludovic Beghin edited this page Apr 14, 2023 · 3 revisions

Getting started

ForeFire is currently only available in Linux.

First, clone the repository locally:

git clone https://github.com/forefireAPI/firefront

Go to the repository directory:

cd firefront

Quick install and build (Ubuntu and Debian distributions)

Run the install script:

sh install-forefire.sh

Manual install and build

Manual install (Ubuntu and Debian distributions)

Run the following commands:

apt-get update
apt install build-essential -y
apt install libnetcdf-dev libnetcdf-cxx-legacy-dev -y
apt install cmake -y

To install:

Manual install (Other Linux distributions)

Use your distribution's package manager to install:

Build

CMake

CMake is the default build tool of ForeFire. To build with CMake run the script

sh cmake-build.sh

Or, alternatively, the individual commands:

mkdir build
cd build
cmake ../
make

Scons

More information on building with Scons is available here.

Docker

A sample Dockerfile can allow to build a Docker image with

docker build . -t forefire

CMake is used in this build.

To run this image and interactively acces the continer use

docker run -it forefire bash

Making ForeFire executable from everywhere

To make the program executable from eveywhere (during the session) Add the bin folder to path

export PATH=$PATH:`pwd`/bin

If you want to change it permanently, paste

export PATH="</path/to/file>:$PATH"

at the end of your ~/.bashrc file. The file can be edited with

nano ~/.bashrc

for example

export PATH="/path/to/repository/firefront/bin:$PATH"

ForeFire interpreter

After building, you will find the ForeFire interpreter in the bin directory. You can test it to see if it was correctly installed:

forefire -version

Or simply:

forefire