FFF Connectors

About

This project uses Python3, NPM(optional) and Docker.

Calculations

1. Hydraulic Suitability Table
2. Hydraulic Suitability Time Series

Setup

Docker is the preferred way of setting up the project. It will resolve most cross OS compatibility issues.

I. Using Docker (Recommended Way)

Docker provides an easy installation process to get the project running in your local machine with near zero-configuration.

1. Install Docker and Git

2. Open Git Bash(Windows) or Terminal(MacOS or Linux)

3. Clone your project in your desired folder by using cd to change directory

   git clone https://github.com/leogoesger/FFF-connectors
   cd FFF-connectors/
   

4. cd into the path of FFF-connections directory, then run shell script

   cd path/to/FFF-connectors
   ./build.sh
   

II. Using Anaconda Spyder (Mac OS and Windows)

1. Clone your project in Terminal or download the entire repo from Github

   git clone https://github.com/leogoesger/FFF-connectors
   cd FFF-connectors/
   

2. Open the folder from Spyder

3. You may need to install these packages if you do not already have them locally

   six==1.11.0
   inquirer==2.2.0
   rasterio==0.36.0
   

4. Click on main.py and run

III. With Mac OS

1. Install Python3, Git and a text editor of your choice.

2. Clone your project in Terminal

   git clone https://github.com/leogoesger/FFF-connectors
   cd FFF-connectors/
   

3. Create and activate virtualenv

   npm setup
   source my-virtualenv/bin/activate
   

4. Install dependencies

   npm install
   

   If you chose not to install npm, use pip as following:

   pip install -r requirement.txt
   

IV. With Windows

1. Install Python3, Git and a text editor of your choice.

2. Add Python to System Path

   • Locate Python3 from your local computer. Usually located in the following folder:

     C:\python3
     

     or

     C:\Users\your-namprojectData\Local\Programs\Python\Python36-32
     

   • Follow this link from step 2 to the end.

   • Go into Command Prompt by typing cmd in search bar, and type python. You should see the following:

     Python 3.6.4 (v3.6.4:d48ecebad5, Dec 18 2017, 21:07:28)
     [GCC 4.2.1projectle Inc. build 5666) (dot 3)] on darwin
     Type "help", "copyright", "credits" or "license" for more information.
     >>>
     

   • Type exit() to exit the python shell.

3. Clone your project in Command Prompt

   git clone https://github.com/leogoesger/FFF-connectors
   cd FFF-connectors
   

4. Create and activate virtualenv

   python -m venv my-virtualenv
   my-virtualenv\Scripts\activate
   

5. Install dependencies

   pip install -r requirements.txt
   

Run Script

1. With Docker. Use Git Bash or Terminal

   ./run.sh
   

   NOTE: If it does not recognize the command, you can open the run.sh with a text editor. Copy what's inside and paste to your Bash/Terminal. You may also need to prefix the command with the warning.

2. With Spyder, click on main.py and run

3. All others, navigate to project directory, use npm with

   npm start
   

   or using python direcly as following:

   python main.py
   

Test

First enter virtualenv with previously discussed steps in project directory.

npm test

or using python directly as following:

python -m unittest discover -v

Error and Bug

Use JIRA to keep upload error message, a screen shot, and raw data file used

Options

iTerm: iTerm2 is a replacement for Terminal in MacOS

License

Copyright (c) 2018

Licensed under the MIT license.