Installation instructions

fl-sim requires Python 3.6+ and is available through pip:

pip install git+https://github.com/wenh06/fl-sim.git

or clone the repository and run

pip install -e .

Alternatively, one can use the Docker image wenh06/fl-sim to run the code. The image is built with the Docker Image CI action. To pull the image, run the following command:

docker pull wenh06/fl-sim

For the usage (interactive mode), run the following command:

docker run -it wenh06/fl-sim bash

For more advanced usages (e.g., run a script), refer to the Docker official documentation.