FLAP - Fusion Library of Analysis Programs¶
This package is intended for analysing large multidimensional datasets.
Install¶
First, clone the FLAP repository from GitHub:
$ git clone https://github.com/fusion-flap/flap.git
Navigate to the newly created flap folder:
$ cd flap
Before installing FLAP, first set up an Anaconda/Mamba environment using the appropriate, platform-specific .yml file provided for either Linux or Windows.
Note
Conda and Mamba
Conda is the environment handling tool in Anaconda. From 2024 conda is free only for enterprises below 200 staff. Mamba is a free alternative providing the same functionality.
Conda can be downloaded and installed from anaconda.org.
Mamba is contained in Miniforge, which can be downloaded from conda-forge. Download the package for your operating system and follow the instructions for installation.
For example, on Windows, from the Anaconda Prompt/Miniforge Prompt run(mamba should be substituted for conda if Mamba is used):
$ conda env create -f docs/flap_windows.yml
Activate the new flap environment:
$ conda activate flap
Install the package:
$ python -m pip install .
Tip
To install FLAP in editable mode (e.g. for development), use the -e flag:
$ python -m pip install -e .
This installs FLAP in such a way that any changes made in the source code are instantly reflected in any software using it. (This is similar to adding the package directory to your $PATH, but more robust.)
Tip
The default environment uses numpy >= 2.0. In case this is incompatible with some additional library needed, *_oldnumpy.yml files are also available in the docs/ folder, which can be used to create environments with an older version of numpy.
Tip
In some cases, the default environment files can conflict with already installed software not managed by conda/mamba, which results in the environment install failing due to dependency problems. In this case, try the *_gentle.yml files. For example, instead of using docs/flap_windows.yml, try using docs/flap_windows_gentle.yml and so on.
FLAP is now ready to use!
Getting started¶
To get started, see the Examples Gallery.
For more information, see the User’s Guide.
Extensions¶
Various extensions are available for FLAP.
API reference¶
For developers, a Guide and an API reference is available.