Installation

CyFi requires python 3.11 or later.

If you already have python 3.11+ installed, simply run pip install cyfi and then head over to the Quickstart page to learn how to generate cyanobacteria predictions.

If you don't have python installed, we strongly recommend using Miniconda. Miniconda is a tool to manage your Python environments and package dependencies. It is a lightweight version of Anaconda that includes only conda, Python, the packages they both depend on, and a small number of other useful packages (like pip).

Follow the instructions for your operating system below to install python (with Miniconda) and CyFi.

Windows instructions

Install python

  1. Download the Miniconda installer by clicking on "Windows 64-Bit (x86_64) Graphical Installer" under Miniconda Windows Miniconda installer links

  2. Double-click the downloaded .exe file

  3. Follow the instructions on the screen. If you are unsure about any setting, accept the defaults.

Install CyFi

Once the Miniconda installation has finished,

  1. From the Start menu, open Anaconda Prompt

  2. Type pip install cyfi and hit enter

  3. To check that CyFi has been installed, run pip show cyfi

$ pip show cyfi
Name: cyfi
Version: 1.1.2
Summary: CyFi is a Python package to estimate cyanobacteria density in small, inland water bodies using Sentinel-2 satellite imagery.

MacOS instructions

Install python

  1. Download the Miniconda installer by clicking on "64-Bit (Apple silicon) Graphical Installer" under Miniconda. macOS Miniconda installer links

  2. Double-click the .pkg file.

  3. Follow the instructions on the screen. If you are unsure about any setting, accept the defaults.

Install CyFi

Once the Miniconda installation has finished,

  1. Open the terminal by typing ⌘+space (to open spotlight search) and then typing "Terminal". Hit enter.

  2. Type conda install -c conda-forge cyfi and hit enter.

  3. When prompted with "Proceed ([y]/n)?", hit enter again.

  4. To check that CyFi has been installed, run pip show cyfi

$ pip show cyfi
Name: cyfi
Version: 1.1.2
Summary: CyFi is a Python package to estimate cyanobacteria density in small, inland water bodies using Sentinel-2 satellite imagery.

Linux instructions

Install python

  1. Download the Miniconda installer by clicking on "64-Bit (x86) Installer" under Miniconda Linux Miniconda installer links

  2. In your terminal, run bash filename, replacing filename with the path to your installer.

  3. Follow the prompts on the installer screens. If you are unsure about any setting, accept the defaults.

  4. To make the changes take effect, close and then re-open your terminal window.

Install CyFi

  1. In your terminal, run pip install cyfi

  2. To check that CyFi has been installed, run pip show cyfi

$ pip show cyfi
Name: cyfi
Version: 1.1.2
Summary: CyFi is a Python package to estimate cyanobacteria density in small, inland water bodies using Sentinel-2 satellite imagery.