Installation (MacOS \ Linux)

(Image updates in progress)

NOTE: This project requires Python 3.7+ to run.

1. Go to the Python page (https://www.python.org/downloads/) and download, then, install Python version 3. Make sure that the checkbox is checked for Python to be added to the PATH

   A more detailed and in-depth guide on how to install Python for your system OS can be found here

2. [Optional] Open a new bash terminal and create and activate a new virtual environment in the project directory:

   mkdir project_directory
   
   cd /path/to/project
   
   python -m venv /path/to/new/virtual/environment
   
   source venv/bin/activate

   

3. Use pip to install the project. For a successful install, look for Successfully installed ... fsf-api-access-python-x.x.x...

   cd /path/to/project
   
   pip install fsf-api-access-python

   

   

4. The project is now setup and can be ran through one of the two methods. See the Products tab for additional details on the flood data products provided by the First Street Foundation API.

   Example Final File Structure:
   
   .
   ├── venv
   ├── my_script.py