The FAIR Data Pipeline needs three components to be installed on your computer in order to run. These are:

Try it without installing anything#

The FDP Tutorial runs in a Docker container with the CLI, the local registry and the example models already installed, and walks through the pipeline in Jupyter notebooks:

docker run -p 8000:8000 -p 8888:8888 ghcr.io/fairdatapipeline/fdptutorial:latest

Prerequisites#

The CLI is installed using pip (the package installer for Python), so you will need Python 3.10 or later (PyPI - Python Version) and git. You will also need to install Graphviz if you would like to view provenance reports in the registry’s web interface.

Install the Command Line Interface (CLI)#

It is recommended to install the CLI in a virtual environment:

pip install fair-cli

See CLI Installation for more details.

Install the (Local) Data Registry#

fair registry install

See Local Registry Installation for more details.

Select and install a Modelling API#

LanguageInstallDetails
CBuilt with the C++ APIC API
C++Build with CMakeC++ API
FORTRANBuild with CMakeFORTRAN API
Javaorg.fairdatapipeline:api on Maven CentralJava API
Juliapkg> add DataPipelineJulia API
Pythonpip install data-pipeline-apiPython API
Rinstall.packages("rDataPipeline")R API

Try out an example#

Example models (a simple SEIRS epidemiological model) using the FAIR Data Pipeline are provided in each of the supported languages. Instructions to install and run these examples can be found in their respective GitHub repositories:

Each example is run the same way: clone the repository, then from inside it run

fair init
fair pull <path to config.yaml>
fair run <path to config.yaml>

Then start the registry with fair registry start and visit http://localhost:8000 to see the inputs and outputs recorded for the run.