Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Introduction, Prerequisites and Installation #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added Introduction, Prerequisites and Installation #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,52 @@
# WEFEDemand
TBD

WEFEDemand is an assessment tool designed to model and analyze the interconnected demands of Water, Energy, Food, and
the Environment (WEFE), particularly in off-grid and decentralized contexts. This tool facilitates a comprehensive
understanding of how these essential systems interact and affect each other with a particular focus on developing
sustainable, resilient, and efficient systems. By simulating the demand dynamics of water, energy, food, and environmental
resources, the tool enables stakeholders, including researchers, policymakers, and local authorities, to make informed
decisions about resource allocation, infrastructure investments, and policy development. WEFEDemand allows users to configure
and run multiple scenarios, customize components, and model demand profiles for various case studies. It adapts to different
contexts, geographic or socio-economic, using real-time data to assess and forecast resource demands, supporting effective
system management, planning, and optimization of integrated WEFE systems.

## Prerequisites

Make sure a supported Python Version (3.9 or greater), pip and an interpreter (preferably PyCharm) is installed on your
system. Additionally, it is recommended to create a free account at [KoboToolbox](https://www.kobotoolbox.org/sign-up/)
if you plan to use the tool’s data collection features.

## Installation

For using the WEFEDemand, clone the repository to your local machine. Then navigate to the repository folder and
create a new virtual environment with a supported Python Version (3.9 or greater). Activate the new virtual environment
and install the necessary python packages using pip and the requirements file:

pip install -r requirements/dev.txt

Add the directory to the pythonpath (look guide for adding a directory to the python-path environment variable on
Windows), for linux type in the terminal:

export PYTHONPATH=$PYTHONPATH:$PWD

This last step has to be done everytime a new terminal is started.

Once all of these steps have been completed successfully, you are ready to run the example!

Enter into the demo directory and run the demo model:

cd ~/WEFEDemand/demo
python dat_ramp_model_demo.py

## Troubleshooting



## 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](https://help.github.com/en/articles/creating-a-repository-from-a-template).

## Code linting

Expand Down