v0.4.0: Modular and More User-Friendly Model

v0.4.0: Modular and More User-Friendly Model

✨ Improvements & Enhancements

• Restructured package for improved organization
• Added functions to generate example data
• Included example configuration file

🚀 New Features

• Simulation of concurrent and compound disaster impacts
• New function to distribute disaster impact based on affected population data

📝 Detailed Changes

• Package Structure: Updated to enhance modularity and ease of use
• Example Data Generation: New utilities to create sample datasets for testing and demonstration
• Configuration: Added an example config file to guide user setup
• Multi-Disaster Modeling: Now supports simulation of overlapping and compounding disaster events
• Impact Distribution: Implemented a function to allocate disaster effects using data on affected populations

What's Changed

• update graph settings by @mikhailsirenko in #60
• Develop by @mikhailsirenko in #61
• Develop by @mikhailsirenko in #62
• Develop by @mikhailsirenko in #63
• Develop by @mikhailsirenko in #64
• Develop by @mikhailsirenko in #65
• Update README.md with repository structure and usage information by @mikhailsirenko in #66
• Clean up by @mikhailsirenko in #67
• Major refactoring and update to v0.4.0 by @mikhailsirenko in #68
• Clean requirements.txt by @mikhailsirenko in #69
• Make requirements.txt with pipreqsnb by @mikhailsirenko in #70

Full Changelog: v0.3.0...v0.4.0

v0.3.0 Validated model

Validated model (2 September 2023)

✨ Improvements & Enhancements

• Major refactoring;
• Disentangle functions from different modules from each other.

🚀 Features

• Generate docs with pdoc;
• Automatically update docs on merge with GitHub Actions;
• First tests;
• Move model parameters to a yaml file in the config folder.

🐛 Bug fixes

• Make duplicate_households a part of the pipeline;
• Fix wellbeing calculation;
• Change socio-economic resilience calculation;
• Replace median_productivity calculated on the household level with countries' average_productivity from the Penn World Table.

v0.2.2

Policy analysis (7 August 2023)

✨ Improvements & Enhancements

• Add an option to run the model with policies (including a dynamic one);
• More elaborate sensitivity analysis & verificataion.

🚀 Features

• Policy analysis in notebooks/policy_analysis.ipynb;
• Allow for the model run with and without income loss.

🐛 Bug fixes

• Fix a significant bug in integrate_wellbeing().

v0.2.1

Verified model (2 August 2023)

✨ Improvements & Enhancements

• Further modularise the code and restructure the repo.

🚀 Features

• Add new visualisations via visualise.py: choropleth and bi-variate choropleth to analysis.ipynb.

🐛 Bug fixes

• Fix a significant bug in determine_affected;
• Fix a bug in calculate_poverty_gap.

v0.2.0

EMA Workbench MultiprocessingEvaluator friendly model (19 June 2023)

✨ Improvements & Enhancements

• Refactor the model from OOP to PP.

🚀 Features

• Can run the model on multiple cores with EMA Workbench MultiprocessingEvaluator.

v0.1.0

EMA Workbench friendly model (18 June 2023)

✨ Improvements & Enhancements

• Restructure the model to make it usable by EMA Workbench;
• Move data preparation to prepare_data.py (it must be used outside of the model run);
• Add docstrings for all methods;
• Draft verification of the individual methods and the model outcomes (verification.ipynb);
• Draft sensitivity analysis (sensitivity_analysis.ipynb).

🚀 Features

• The model can be run with EMA Workbench (single core only yet);
• Add new outcomes of interest.

🐛 Bug fixes

• Fix model pipeline.

v0.0.1

Initial release v0.0.1 (24 June 2023)

✨ Improvements & Enhancements

• Split the model code into modules;
• Split the initial data preparation notebook in a series of functions (it makes it easier to debug);
• Add methods to generate outcomes of interest;
• Visualise model outcomes with of rain cloud plot.

🚀 Features

• Allow for the change of all (random) parameters in a __main__.py.

🐛 Bug fixes

• Fix duplicate_households().