epfl-enac / bpe-sesvc

bpe-sesvc

UNHCR GTH - Energy Planning tool

Status

Currently under development.

Development

• We use husky for git hooks: https://typicode.github.io/husky/#/?id=install
• We use standard version and commitlint for automatic release log and proper commit message

Prerequisites

Prerequisites:

• Make (gnu make)
• Node.js 16.x
  • use nvm https://github.com/nvm-sh/nvm#installing-and-updating
  • nvm install --lts; nvm use --lts
• [yarn]
• Docker
  • Docker Compose 1.27.0+

Run for development

Create .env file to hold your Secrets

An environment file should be created; you may copy paste the following code, don't forget to replace by the appropriate bucket name and HOSTNAME

tee -a .env << EOF
COUCHDB_USER=admin
COUCHDB_PASSWORD=couchdb
COUCHDB_HOST=localhost
# EPFL DNS
DNS=128.178.15.8

EOF

Installation

make install

CLI

make run-database;
make setup-database;
make run-frontend;
# http://127.0.0.1:8080

Visual Studio Code

Run configurations are in .vscode: https://code.visualstudio.com/docs/editor/debugging

Deployment

Local build with Docker Compose

make run # will build with docker-compose and run docker-compose up -d

Server

We use enacit-ansible to automate our process

Just run the following command and it will install the latest commit from the main branch

ansible-playbook -v -i inventory/sesvc.epfl.ch.yml  playbooks/deploy-app.yml

• If you change couchdb-setup/etc/config.ini file
  • You'll need to do the following:

    ssh sesvc.epfl.ch
    # wait to be connected
    cd /opt/sesvc;
    docker-compose restart couchdb;
    

Deployment process

• monthly (by the 1st) releases onto the production environment http://sesvc.epfl.ch/ including only features validated.
• intermediate releases may happen occasionally for hot fixes

Releases number follow [semantic versioning conventions](https://semver.org/\).

Create a new user

There is two way of doing this: first one using curl; second one using couchdb-bootstrap

Using curl

1. Follow: https://docs.couchdb.org/en/stable/intro/security.html#creating-a-new-user

curl -X PUT http://localhost:5984/_users/org.couchdb.user:[email protected] \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{"name": "[email protected]", "password": "plain_text_password_that_will_be_encrypted", "roles": [], "type": "user"}'

2. retrieve the inserted documented

 curl -X GET http://admin:couchdb@localhost:5984/_users/org.couchdb.user:[email protected] \
     -H "Accept: application/json" \
     -H "Content-Type: application/json"

{"_id":"org.couchdb.user:[email protected]","_rev":"1-xxxx","name":"[email protected]","roles":[],"type":"user","password_scheme":"pbkdf2","iterations":10,"derived_key":"917a923abd865bc82feadd5659a1d0d55318ca49","salt":"83f9a989d48e31b7a5e99c28df8a989c"}

3. add the result json from above inside add the above json result as new file in couchdb-setup/bootstrap/_users/[email protected] : 3.a you can remove the _rev field

{
  "_id": "org.couchdb.user:[email protected]",
  "name": "[email protected]",
  "roles": [],
  "type": "user",
  "password_scheme": "pbkdf2",
  "iterations": 10,
  "derived_key": "917a923abd865bc82feadd5659a1d0d55318ca49",
  "salt": "83f9a989d48e31b7a5e99c28df8a989c"
}

Using couchdb bootstrap

• add a new file inside couchdb-setup/bootstrap/_users with

{
  "_id": "org.couchdb.user:[email protected]",
  "name": "[email protected]",
  "roles": [],
  "type": "user",
  "password": "plain_text_that_will_be_hash_by_couchdb",
}

• run the following command:

make setup-database

• CouchDB has hashed the password, you can get it on http://localhost:5984/\_utils/#database/\_users/\_all_docs
• find the new user and download
• save the document by deplacing couchdb-setup/bootstrap/_users/new_username.json
• remove the '_rev' field and commit the file

Update public keys for unhcr azure server

• run make azure

make azure

• then copy the content of the json azure/jwt_keys.json at the proper place inside couchdb-setup/bootstrap/_config.json
• verify that the json is valid

Collaborators

EPFL Essential Tech Center ENAC FAR ENAC-IT4R

bpe-sesvc's Issues

[FEATURE] Energy interventions : Cash-based interventions implementation

• Confirm contents and equations - Inputs:

1. Name of intervention
2. First year of intervention (must be higher or equal to the first year of the planning
   period)
3. Last year of intervention (must be lower or equal to the last year of the planning period)
4. Targeted QLLs -- multiselect (Quality of life levels)
5. Cost affordability yearly objective:

• QLL 1 [%] -- if selected in (4)
• QLL 2 [%] -- if selected in (4)
• QLL 3 [%] -- if selected in (4)
• QLL 4 [%] -- if selected in (4)
• QLL 5 [%] -- if selected in (4)

5a. "Cost affordability objective differ each year" -- opens a pop up with a table of all year, all QLL to put different objectives? /!/!\ /!\

• Implement user inputs in the placeholder tab.

• Implement the equations in section 3 in this design document :
  Energy Planning Tool - New modeling of interventions.pdf

[FEATURE](Energy Ref Data): Add sources to Fuels + Stoves

• UNHCR asks to add a "source" column with the reference of where the data comes from, for Fuels and Stoves.
• Add cookstoves images in the Reference Data tab

[POLISH] Database tables should have unlimited rows per page

** Which part/screens of the tool? **

• DB tab

Don't limit the number of rows per page except if DB contains ≥ 50-100 rows.

[FEATURE] Energy planning second baseline comparison

Hi Charlie, looking forward to meeting you tomorrow. We added a second baseline ( called Min BAU Kebri beyah) with its own affiliated inputs, but the results do not match the tool this time. For our reference case, as mentioned, it looks good. Yet I cannot see the reason of the discrepancy. I let you take a look at the excel, and maybe we also talk tomorrow on this when we meet.

Hi @charlie Weil, thank you for the great updates on the tool. I have checked the third scenario, OK Max Baseline (excel file attached), and made a third administrator template on the app. The exact same problem there is as it was for the OK Min Baseline. I suggest the discrepancies are rooted in the rounded number of proportion (%), but to be checked. Thanks!

OK Min_Baseline1.1_v1.xlsx

OK Max_BAU.xlsx

[BUG] <Scenario : When saving data, avoiding going back to base year>

[FEAT](App structure) : remove menu

Remove menu now that we have a single app. Merge all info in About etc in a single landing page.

Put all logos in a single line.

[FEATURE] Energy planning info tab

• Rename “Shelters Types” by “housing Types” and have it viewed as a treemap by default if values are filled - with these values (and an “Edit ” button that changes to displaying the fields to fill).

[FIX](Scenario): Constraints on valid values for increase rates at wrong (Minimum 0.)

Is there an existing issue for this?

• I have searched the existing issues

Expected Behavior

"Growth rate of pop" et all "increase rates": can be positive or negative
Improve error message that says "Minimum 0."

Anything else?

No response

[FEATURE] Cookstoves table UX improvements

• mprove UI/UX for Cookstove selection

  • In the full version of cookstove : add cookstove photos
  • (+Add cooking technoology) button : Select stove, then select fuel
  • Add cookstoves per years (by default, paste the data from Year 0)

• Simplified view (for the HHCooking expandable section) should only have the following columns: (Keep the per-year view with the menu)

• Photo

• Cookstove

• Fuel

• Total #

  • Upon hovering on the row of a given cookstove, you see a pie plot of the distribution of cookstoves “count per hh” for each SES cateogory.

• [COOKSTOVES LIST](https://docs.google.com/spreadsheets/d/1WfFT5zLI8q9lZnfJz915MiEEQN1womr6/edit#gid=1172786498) should appear in the Reference Data tab!

• Ability to add a custom cookstove to the DB /canceled

[FEATURE] Energy Tool General Improvements

• eCharts Graph export
• Report PDF export, including graphs

[BUG] Page is refreshed automatically

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

When editing a form, after a while the page is refreshed and data are lost

Expected Behavior

No response

Steps To Reproduce

No response

Environment

No response

Anything else?

No response

[FEATURE] Energy planning summary tab

---

From @charlottegiseleweil to @prof. Edgard Gnansounou

thank you for the fruitful discussion today. I will be off tomorrow and Friday, but I have convened the specs to David who will keep working on implementation.

Now that the results/graphs are integrated within each module - I propose to keep the main “Results” tab and turn it into “SUmmary”. We still need to design this tab - could you tell us what kind of information you would like to eventually see in this final “Summary” tab with the key results of each module for example ?

---

Response from Prof.

@charlie Weil : Dear Charlie - Thank you for your message. regarding your question, I have already answer it in my excel files where a summary of the results is presented.

[FEATURE] Data Export

Describe the solution you'd like

HH Cooking Data export functionalities:

• Export Outputs Results table (with given selection of interventions/not) . Verify that it contains all variables described in Part II + III described in doc Energy Planning Tool data to export.docx

• Integrate key KPIs in the Outputs export. (August)

• Export of Inputs (Part I. A+B+C) (August)

[FEATURE] Radar Chart ?

Describe the solution you'd like
Add a radar chart/KPIs. Waiting on clear specs from Edgard.

Indicators for the comparison between the reference and alternative casesdocx (1).docx

[FEATURE] Energy Interventions (i) hover

• On HH Cooking screen, add 3 (i) buttons (for each intervention type) with explanations of the interventions upon hover. The following texts should be displayed:

1. Energy substitution
   Through an energy substitution, a conventional or improved technology of the reference system is replaced by a clean or specific technology including solar cookers.
2. Energy efficiency improvement
   With this type of basic intervention, a conventional technology of the reference system is replaced by an improved one that uses the same fuel but with an improved efficiency.
3. Cash-based interventions
   The aim is to provide poor households with subsidies to improve their energy cost affordability.

[FEATURE] Results Details : Ability to Download “Details” table as CSV

Results Details : Ability to Download “Details” table as CSV

[FEATURE] Energy Interventions - Energy subsitution (fixes)

Fixes based on latest specs - Energy Planning Tool - New modeling of interventions.pdf
Input lists and equations to be confirmed still.

• Rename/list of inputs for Energy substitution intervention as follow :

• Name of intervention -- text
• New cookstove to diffuse -- dropdown: select cookstove
• First year of intervention -- must be higher or equal to the first year of the planning
  period
• Last year of intervention -- must be lower or equal to the last year of the planning period
• Technologies to replace (in order) -- multiselect
• Target QLL groups -- multiselect
• Number of cookstoves per year (count per 10 hh)-- int
• Total cost per year -- float (TO BE REMOVED? EDGARD?)
• Share of subsidies:

• • Quality of Life Level 1 :
• • Quality of Life Level 2 :
• • Quality of Life Level 3 :
• • Quality of Life Level 4 :
• • Quality of Life Level 5 :