Getting started

LBAF currently supports Python 3.8 - 3.11. You can download Python here .

Create a virtual environment

To create and activate a virtual environment:

python -m venv venv
source venv/bin/activate

Installation

LBAF can be installed in two ways:

1. Install the LBAF Package (recommended)

Users can easily install the latest release of LBAF with:
pip install lbaf
Developers should clone the repo and install the package in editable mode:
git clone git@github.com:DARMA-tasking/LB-analysis-framework.git
pip install -e LB-analysis-framework

2. Install Dependencies

If you do not wish to install LBAF as a package, simply clone the repo and install dependencies:
git clone git@github.com:DARMA-tasking/LB-analysis-framework.git
pip install -r LB-analysis-framework/requirements.txt