## Author - 	     Vindhya Basnayake
## Journal article - A Global Assessment of Coastal Vulnerability and Dominant Contributors
## Affiliation -     University of Twente, The Netherlands	

General
=======
This read_me.txt file describes the contents of this data folder 'CVI_Data'.

Folder Contents
===============
This folder contains the python scripts that need to generate the Figures in main manuscript and supplementary information document associated with the journal article 'A Global Assessment of Coastal Vulnerability and Dominant Contributors', together with the required data.

- Validation:                             Sub folder containing the validation data
- Countrywise_CVI:                        Sub folder containing the results of countrywise CVI assessment
- IPCC_Regions_CVI:                       Sub folder containing the results of IPCC regionwise CVI assessment
- Typology_based_CVI:                     Sub folder containing the results of typology based CVI assessment
- Indicator_contribution:                 Sub folder containing the results of contributions from indicators to the overall CVI
- CVI_Percentile_ranges:                  Sub folder containing the CVI value ranges for CVI class classification 
- Figure1_Validation.py:                  Python script to generate Figure 1 in the manuscript
- Figure2_Countrywise_CVI_plot.py:        Python script to generate Figure 2 in the manuscript
- Figure3_Regionwise_CVI_plot.py:         Python script to generate Figure 3 in the manuscript
- Figure4_Typology_based_CVI_plot.py:     Python script to generate Figure 4 in the manuscript
- Figure5_Indicator_contribution_plot.py: Python script to generate Figure 5 in the manuscript
- meta_data.yml:                          Contains information on all the data files
- read_me.txt:                            Describes the contents of the main folder
- run_all.bat:                            A batch file to run all the scripts
        
System requirement
==================
Python 3.11 with the following packages are required.
    •	pandas
    •	geopandas
    •	shapely
    •	numpy
    •	matplotlib
    •	math
    •	openpyxl
    

Generating Figures
==================
Data required to reproduce the results figures from the paper are provided in the same folder as this read_me.txt. Run the batch file 'run_all.bat' to reproduce the figures.

