Ruralwater¶
Purpose of the project¶
Motivation¶
How to install ‘ruralwater’ on your local machine¶
Python 3.7+
Redis
webapp.core.settings.redis.py
:
USE_REDIS = True
and set it to False
.clone the
development
branch on you local machinerun the script
setup_linux_complete.sh
(linux) orsetup_win_complete.ps1
(windows)Navigate to localhost (http://127.0.0.1:8000/)
Manual installation
clone the “development” branch on you local machine
create and activate a virtual environment
install the requirements at requirements/development.txt
run the script
setup_linux_database.sh
(linux) orsetup_win_database.ps1
(windows)Navigate to localhost (http://127.0.0.1:8000/)
setup_*_database
implements
the following operations:generates the database (using the django framework)
populates the database with the hydraulic hardware data
creates a superuser and two mock users:
‘demo’, who is the superuser, with password: pippo121
‘cat’, with password: meow
‘dog’, with password: bark
Contributing¶
XXX for an introduction to the ‘application programming interface’ exposed by the ‘business logic’
For contributors more interested in “test-driven development” XXX provides the description of the tests currently included in this repository.
Current status of the project¶
the algorithm to optimize the design of dendridic gravity-fed water supplies
the design of the user interface, more specifically the javascript for the client side controls to define the water supply.|
Tech/framework used¶
Ruralwater is built with:
Tests¶
cd into the ‘webapp’ folder
run:
python manage.py runserver
run:
python manage.py test
testing
forlder
and specifically inside the file howto_casestudies.md.
cd into the ‘webapp’ folder
run:
python manage.py runserver
Authors¶
Claudio Finizio (Initial work)