Installation

Getting ForML

To install the pre-packaged version of ForML simply use pip:

pip install forml

ForML has a number of optional features with their own dependencies which can be pulled in during the installation like this:

pip install 'forml[presto,dask]'

Some of the features might have their own binary dependencies that need to be resolved using a system-dependant way (ie using the OS package manager).

Extra Features

Feature

Install Command

Description

all

pip install 'forml[all]'

All extra features

dask

pip install 'forml[dask]'

The Dask runner

dev

pip install 'forml[dev]'

ForML development tools

doc

pip install 'forml[doc]'

Documentation publishing dependencies

flow

pip install 'forml[flow]'

The standard operator and actor library shipped with ForML

graphviz

pip install 'forml[graphviz]'

The Graphviz pseudo-runner (also requires graphviz binary)

presto

pip install 'forml[presto]'

The PrestoDB reader