VN-CSS-Scenario

A recursive model of electricity production in Vietnam

(c) Dr. Minh Ha-Duong, CNRS, 2017 < minh.haduong@gmail.com >

All files licensed under the Creative Commons Attribution-ShareAlike 4.0 International see file LICENSE.TXT unless noted otherwise

Reproductibility in three steps:

git clone https://github.com/MinhHaDuong/VN-CSS-Scenario.git
cd VN-CCS-Scenario/ 
make

Installation and use:

The code is in Python 3.6 it imports hashlib, sys, copy, functools from the standard library it imports pandas, mathplotlib, numpy from the scientific python core packages it uses statsmodels from the PyPI

To install dependencies: sudo -H pip3 install -r requirements.txt

The builds uses a standard Makefile with

• make run the model, all sensitivity analysis to build all tables and figures.

• make test perform regression tests, docstests, and scripted tests (if any)

• make reg_tests_reset copy results tables from the current dir into tables.tocompare/

• make clean delete results files

• make cleaner delete results files and Python cache files

Development:

Under Linux, spyder3 reads editor configuration from ~/.config/pep8

max-line-length = 100
ignore=W503,E402

Directory organization:

1. Files in data/ are raw data collected (PDF, XLS, web pages) from the web.

2. Intermediate CSV or TXT (when used), are also in data/

3. Files starting with data_X mostly make available the data found in data/X/

4. Files starting with an Upper case define the class with that name: Plan, Parameter, Run

5. Files starting with plan_ instanciate a Plan object

6. Files starting with parameter_ instanciate a Parameter object

7. Files starting with run_ instanciate one or more Run object-s

8. Files starting with test_ are used by the pytest framework.

9. Files in tables.tocompare are used for regression testing. Use make reg_tests_reset to populate/update it.

Code quality: