Skip to content

Latest commit

 

History

History
67 lines (37 loc) · 3.72 KB

README.md

File metadata and controls

67 lines (37 loc) · 3.72 KB
Raw

WEFESiteAnalyst

automatized remote data collection tool for the site-tailored planning of integrated Water-Energy-Food-Environment Systems (iWEFEs).

The purpose of the tool is the automation of location-specific data collection for site-tailored planning and configuration of iWEFEs. The input to the WEFE Site Analyst are coordinates of the location to be analysed (point-based). Together with OWEFE and the iWEFE configurator, the WEFE Site Analyst contributes to the doctoral project "Facilitating the Planning of Integrated Water-Energy-Food-Environment Systems through Open Source Software".

This repository is generated from rli_template. More information see below.

Installation

software

The currently supported Python Version is 3.9. For using the WEFESiteAnalyst clone the repository to your local machine. Then create a new virtual environment with Python Version 3.9. Activate the new virtual environment and move to the repository folder to install the requirements of WEFESiteAnalyst

 pip install -r requirements.txt

required accounts

The WEFESiteAnalyst uses google earth engine and CDS API. Therefore, a Google Account and a Copernicus Climate Data Store Account are required. You can register for the Copernicus Climate Data Store here. Instructions on how to use CDS API can be found here.

Get started

Environmental data collection

After installation you can use the WEFESiteAnalyst. Therefore you have to run an anaconda prompt on your computer, move to the WEFESiteAnalyst repository and type "jupyter notebook". The repository will open in an jupyter notebook. In the folder examples, you can see applications of the WEFESiteAnalyst for various locations. For analyzing a new location you can use WEFESiteAnalyst/examples/generic/WEFESiteAnalyst.ipynb. Here you can try out the WEFESiteAnalyst for any location on the globe. For storing the retrieved data for a new specific location in your repository, you can create a new folder "WEFESiteAnalyst/example/<new_location>/". Move the WEFESiteAnalyst.ipynb file to the newly created folder and run it to analyze the location and download site-specific WEFE data.

rli_template

Template repository for creating new projects under the RLI's umbrella

Get started

Simply click on the green Use this template button on the left of the Clone or download button.

The detailed instructions to create a new repository from this template can be found here.

src folder

This folder is where you should place the code of your package (package name to be edited in setup.py under name)

You can install it locally for developing with

python setup.py install

More details for packaging are available on https://packaging.python.org

Docs

To build the docs simply go to the docs folder

cd docs

Install the requirements

pip install -r docs_requirements.txt

and run

make html

The output will then be located in docs/_build/html and can be opened with your favorite browser

Code linting

In this template, 3 possible linters are proposed:

  • flake8 only sends warnings and error about linting (PEP8)
  • pylint sends warnings and error about linting (PEP8) and also allows warning about imports order
  • black sends warning but can also fix the files for you

You can perfectly use the 3 of them or subset, at your preference. Don't forget to edit .travis.yml if you want to desactivate the automatic testing of some linters!