diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..169b916 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,30 @@ +name: Publish to GitHub Pages + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + cache: "pip" + - name: Dependencies + run: | + pip install -r docs/requirements.txt + - name: Build Jupyter Book + run: | + jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' && job.status == 'success' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./_build/html + enable_jekyll: false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a0de97d --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# ignore the _build directory +_build/ \ No newline at end of file diff --git a/README.md b/README.md index 07d3b8a..81c9fd8 100644 --- a/README.md +++ b/README.md @@ -6,60 +6,58 @@ This tool employs a multicriteria evaluation (MCE) framework to spatially descri ## User Manual -- [1 Install QGIS](#1-install-qgis) - -- [2 Install Open Route Service (ORS) plugin](#2-install-open-route-service-ors-plugin) - -- [3 Installing Plugin on local device](#3-installing-plugin-on-local-device) - -- [4 Using the Plugin](#4-using-the-plugin) - - [4.1 Setup Tab](#setup-tab) - - [4.2 Indivdual Tab](#indivdual-tab) - - [4.2.1 Education](#education-tab) - - [4.2.2 Care Responsibilities](#care-responsibilities-tab) - - [4.2.3 Domestic Violence](#domestic-violence-tab) - - [4.2.4 Aggregation](#id-aggregation-tab) - - [4.3 Contextual Tab](#contextual-tab) - - [4.3.1 Policy and Legal Protection](#policy-and-legal-protection-tab) - - [4.3.2 Access to Finance](#access-to-finance-tab) - - [4.3.3 Aggregation](#cd-aggregation-tab) - - [4.4 Accessibility Tab](#accessibility-tab) - - [4.4.1 Women's Travel Patterns](#womens-travel-patterns-tab) - - [4.4.2 Access to Public Transport](#access-to-public-transport-tab) - - [4.4.3 Education and Training Facilities](#education-and-training-facilities-tab) - - [4.4.4 Jobs](#jobs-tab) - - [4.4.5 Health Facilites](#health-facilities-tab) - - [4.4.6 Financial Facilities](#financial-facilities-tab) - - [4.4.7 Aggregation](#ad-aggregation-tab) - - [4.5 Place Characterization Tab](#place-charaterization-tab) - - [4.5.1 Active Transport](#active-transport-tab) - - [4.5.2 Availability of Public Transport](#availability-of-public-transport-tab) - - [4.5.3 Safe Urban Design](#safe-urban-design-tab) - - [4.5.4 Security](#security-tab) - - [4.5.5 Income Level](#income-level-tab) - - [4.5.6 Electricity Access](#electricity-access-tab) - - [4.5.7 Level of Urbanization](#level-of-urbanization-tab) - - [4.5.8 Size of Housing](#size-of-housing-tab) - - [4.5.9 Digital Inclusion](#digital-inculsion-tab) - - [4.5.10 Natural Environment and Climatic Factors](#natural-environment-and-climatic-factors-tab) - - [4.5.11 Aggregation](#pd-aggregation-tab) - - [4.6 Dimension Aggregation Tab](#dimension-aggregation-tab) - - [4.7 About Tab](#about-tab) - - [4.8 Insights Tab](#insights-tab) - - [4.8.1 Enablement](#enablement-tab) - - [4.8.2 RE Zone Raster Locations](#re-zone-raster-locations-tab) - - [4.8.3 RE Point Locations](#re-point-locations-tab) - -- [5 Troubleshooting](#5-troubleshooting) - - [5.1 ERROR: Accessibility tabs permission error](#accessibility-permissions-error) - - [5.2 QGIS plugin/interface widgets and text are distorted and scaled incorrectly](#distorted) - - [5.3 Raster outputs not being loaded and displayed correctly](#raster-outputs) - - [5.4 ERROR: Output directory not set](#output-directory) - - [5.5 ERROR: Country boundary polygon not set](#country-boundary) - - [5.6 ERROR: Co-ordinate reference system (CRS) not set](#crs) - - [5.7 Alternative way to refresh the plugin if it freezes or does not run as expected](#alternative) - -- [List of CRSs for SIDS](#sids-crs) +- [Gender Enabling Environments Spatial Tool (GEEST)](#gender-enabling-environments-spatial-tool-geest) + - [User Manual](#user-manual) + - [1 Install QGIS](#1-install-qgis) + - [2 Install Open Route Service (ORS) plugin](#2-install-open-route-service-ors-plugin) + - [3 Installing Plugin on local device](#3-installing-plugin-on-local-device) + - [4 Using the Plugin](#4-using-the-plugin) + - [ 4.1 SETUP TAB](#-41-setup-tab) + - [4.2 INDIVIDUAL TAB](#42-individual-tab) + - [4.2.1 Education](#421-education) + - [4.2.2 Care Responsibilities](#422-care-responsibilities) + - [4.2.3 Domestic Violence](#423-domestic-violence) + - [4.2.4 Aggregate](#424-aggregate) + - [4.3 CONTEXTUAL TAB](#43-contextual-tab) + - [4.3.1 Policy and Legal Protection](#431-policy-and-legal-protection) + - [4.3.2 Access to Finance](#432-access-to-finance) + - [4.3.3 Aggregate](#433-aggregate) + - [4.4 ACCESSIBILITY TAB](#44-accessibility-tab) + - [4.4.1 Women's Travel Patterns](#441-womens-travel-patterns) + - [4.4.2 Access to Public Transport](#442-access-to-public-transport) + - [4.4.3 Access to Education and Training Facilities](#443-access-to-education-and-training-facilities) + - [4.4.4 Access to Jobs in the RE sector](#444-access-to-jobs-in-the-re-sector) + - [4.4.5 Access to Health Facilities](#445-access-to-health-facilities) + - [4.4.6 Access to Financial Facilities](#446-access-to-financial-facilities) + - [4.4.7 Aggregate](#447-aggregate) + - [4.5 PLACE CHARACTERIZATION TAB](#45-place-characterization-tab) + - [4.5.1 Active Transport](#451-active-transport) + - [4.5.2 Availability of Public Transport](#452-availability-of-public-transport) + - [4.5.3 Safe Urban Design](#453-safe-urban-design) + - [4.5.4 Security](#454-security) + - [4.5.5 Income Level](#455-income-level) + - [4.5.6 Electricity Access](#456-electricity-access) + - [4.5.7 Level of Urbanization](#457-level-of-urbanization) + - [4.5.8 Size of Housing](#458-size-of-housing) + - [4.5.9 Digital Inclusion](#459-digital-inclusion) + - [4.5.10 Natural Environment and Climatic Factors](#4510-natural-environment-and-climatic-factors) + - [4.5.11 Aggregate](#4511-aggregate) + - [4.6 DIMENSION AGGREGATION TAB](#46-dimension-aggregation-tab) + - [4.7 ABOUT TAB](#47-about-tab) + - [4.8 INSIGHTS TAB](#48-insights-tab) + - [4.8.1 Enablement](#481-enablement) + - [4.8.2 RE Zone Raster Locations](#482-re-zone-raster-locations) + - [4.8.3 RE Point Locations](#483-re-point-locations) + - [5 Troubleshooting](#5-troubleshooting) + - [5.1 ACCESSIBILTY TABS PERMISSIONS ERROR](#51-accessibilty-tabs-permissions-error) + - [5.2 QGIS PLUGIN/INTERFACE WIDGETS AND TEXT ARE DISTORTED AND SCALED INCORRECTLY](#52-qgis-plugininterface-widgets-and-text-are-distorted-and-scaled-incorrectly) + - [5.3 RASTER OUTPUTS NOT BEING LOADED AND DISPLAYING CORRECTLY](#53-raster-outputs-not-being-loaded-and-displaying-correctly) + - [5.4 ERROR: OUTPUT DIRECTORY NOT SET](#54-error-output-directory-not-set) + - [5.5 ERROR: COUNTRY BOUNDARY POLYGON NOT SET](#55-error-country-boundary-polygon-not-set) + - [5.6 ERROR: CO-ORDINATE REFERENCE SYSTEM (CRS) NOT SET](#56-error-co-ordinate-reference-system-crs-not-set) + - [5.7 ALTERNATIVE WAY TO REFRESH THE PLUGIN IF IT FREEZES OR DOES NOT RUN AS EXPECTED](#57-alternative-way-to-refresh-the-plugin-if-it-freezes-or-does-not-run-as-expected) +- [List of CRSs for SIDS](#list-of-crss-for-sids) +- [License](#license) ## 1 Install QGIS @@ -185,9 +183,9 @@ Examples of files that can be used as input at a particular step as per the Pilo ![image](https://github.com/worldbank/GEEST/assets/120469484/6ff06edc-198a-4807-a59f-038f1b401d43) 1. Create a project folder that will be used to store all tool outputs. - + 3. Set the output directory to the project folder created in the previous step. - + 5. Set the country boundary layer by navigating to and selecting the **Admin 0** country boundary polygon shapefile for the country you want to analyze. **Input File:** *AdminBoundaries/Admin0.shp* @@ -251,7 +249,7 @@ Examples of files that can be used as input at a particular step as per the Pilo 1. Navigate to and select the polygon input shapefile containing a field reporting the percentage of women who have suffered domestic violence. **Input File:** *DomesticViolence/Prevalence_of_domestic_violence.shp* - + 3. Click the "Set" button to extract all the fields from the polygon input layer. 4. Select the field containing the numeric value representing the percentage of women who have suffered domestic violence. @@ -295,7 +293,7 @@ _If a factor is missing it needs to be given a weighting of 0%. All factors shou 1. Navigate to and select polygon input shapefile containing a field reporting a percentage representing the level of protective policies afforded to women. **Input File:** *PolicyLegal/Regulatory_Framework_Law_agg.shp* - + 3. Click the "Set" button to extract all the fields from the polygon input layer. 4. Select the field containing the numeric value representing a percentage representing the level of protective policies afforded to women. @@ -364,7 +362,7 @@ If a factor is missing it needs to be given a weighting of 0%. All factors shoul - Recreational areas **Input File:** *Amenities/Daycares_elementary_schools.shp* - + **Input File:** *Amenities/Grocery_stores.shp* 2. Select the mode of travel (Walking OR Driving). @@ -811,7 +809,7 @@ _If a dimension is missing it needs to be given a weighting of 0%._ ![image](https://github.com/worldbank/GEEST/assets/120469484/a949054b-1b8e-46f6-9279-fdd2b54212de) -Information on the tool its framework, scoring system, and how results should or can be interpreted. +Information on the tool its framework, scoring system, and how results should or can be interpreted. ### 4.8 INSIGHTS TAB #### 4.8.1 Enablement @@ -847,7 +845,7 @@ Information on the tool its framework, scoring system, and how results should or **Aggregation** 12. Navigate to and select the "Combine Classification" output raster file produced in **step 10**. This file path will be automatically populated if **step 10** was executed in the same work session. - + 13. Navigate to and select the aggregation input shapefile. This can be any polygon layer representing boundaries of interest for aggregation (e.g. municipal boundary layer) **Input File:** *AdminBoundaries/Admin6.shp* (**Any admin level can be used as input**) @@ -954,8 +952,8 @@ If you see the following error message, please check if you're CRS has been set 1.2 In the search bar type “plugin reloader”. - 1.3 Select the “Plugin Reloader” plugin and click on the install button. - + 1.3 Select the “Plugin Reloader” plugin and click on the install button. + ![image](https://github.com/worldbank/GEEST/assets/120469484/801db189-92ca-4755-a79f-8898b2e43a2f) @@ -1011,3 +1009,5 @@ If you see the following error message, please check if you're CRS has been set | Tuvalu | WGS 84 / UTM zone 60S | 32760 | | Vanuatu | WGS 84 / UTM zone 59S | 32759 | +# License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..746991f --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[github@worldbank.org](mailto:github@worldbank.org) +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..05fea24 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,40 @@ +# Book settings +title: +author: Development Data Group +logo: docs/images/wb-logo.svg +only_build_toc_files: true + +repository: + url: https://github.com/worldbank/template + branch: main + +####################################################################################### +# HTML-specific settings +html: + home_page_in_navbar: true + extra_navbar: "" + use_edit_page_button: true + use_repository_button: true + use_issues_button: true + baseurl: https://worldbank.github.io/template + extra_footer: | +