Installation ============ This page describes how to install APPFL on a machine independent of operating systems. Conda environment ----------------- We highly recommend to create new conda environment and install the required packages for APPFL. .. code-block:: console conda create -n APPFL python=3.10 conda activate APPFL User installation ----------------- For most users, including data scientists, this simple installation is sufficient for running the package. .. code-block:: console pip install pip --upgrade pip install "appfl[examples]" If you want to even minimize the installation of package dependencies, you can use: .. code-block:: console pip install appfl .. note:: ``torch`` may need to be updated manually to supprt CUDA. Please check GPU support in `PyTorch `_. Developer installation ---------------------- Code developers and contributors may want to work on the local repository. To set up the development environment, .. code-block:: console git clone --single-branch --branch main https://github.com/APPFL/APPFL.git cd APPFL pip install -e ".[dev,examples]" On Ubuntu, if the installation process failed, you can try: .. code-block:: console sudo apt install libopenmpi-dev,libopenmpi-bin,libopenmpi-doc