Skip to content

Commit

Permalink
updating pages again
Browse files Browse the repository at this point in the history
  • Loading branch information
bpstewar committed Nov 15, 2024
1 parent 3eac6c2 commit 2064e13
Show file tree
Hide file tree
Showing 19 changed files with 771 additions and 0 deletions.
4 changes: 4 additions & 0 deletions _static/mycss.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
p {
text-align: justify;
}

9 changes: 9 additions & 0 deletions api/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
src
===

.. toctree::
:maxdepth: 4

space2stats
space2stats_ingest
tests
61 changes: 61 additions & 0 deletions api/space2stats.api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
space2stats.api package
=======================

Submodules
----------

space2stats.api.app module
--------------------------

.. automodule:: space2stats.api.app
:members:
:undoc-members:
:show-inheritance:

space2stats.api.db module
-------------------------

.. automodule:: space2stats.api.db
:members:
:undoc-members:
:show-inheritance:

space2stats.api.errors module
-----------------------------

.. automodule:: space2stats.api.errors
:members:
:undoc-members:
:show-inheritance:

space2stats.api.handler module
------------------------------

.. automodule:: space2stats.api.handler
:members:
:undoc-members:
:show-inheritance:

space2stats.api.schemas module
------------------------------

.. automodule:: space2stats.api.schemas
:members:
:undoc-members:
:show-inheritance:

space2stats.api.settings module
-------------------------------

.. automodule:: space2stats.api.settings
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: space2stats.api
:members:
:undoc-members:
:show-inheritance:
53 changes: 53 additions & 0 deletions api/space2stats.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
aspace2stats package
===================

Subpackages
-----------

.. toctree::
:maxdepth: 4

space2stats.api

Submodules
----------

space2stats.h3\_utils module
----------------------------

.. automodule:: space2stats.h3_utils
:members:
:undoc-members:
:show-inheritance:

space2stats.lib module
----------------------

.. automodule:: space2stats.lib
:members:
:undoc-members:
:show-inheritance:

space2stats.settings module
---------------------------

.. automodule:: space2stats.settings
:members:
:undoc-members:
:show-inheritance:

space2stats.types module
------------------------

.. automodule:: space2stats.types
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: space2stats
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions api/space2stats_ingest.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
space2stats\_ingest package
===========================

Submodules
----------

space2stats\_ingest.cli module
------------------------------

.. automodule:: space2stats_ingest.cli
:members:
:undoc-members:
:show-inheritance:

space2stats\_ingest.main module
-------------------------------

.. automodule:: space2stats_ingest.main
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: space2stats_ingest
:members:
:undoc-members:
:show-inheritance:
77 changes: 77 additions & 0 deletions api/tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
tests package
=============

Submodules
----------

tests.conftest module
---------------------

.. automodule:: tests.conftest
:members:
:undoc-members:
:show-inheritance:

tests.test\_api module
----------------------

.. automodule:: tests.test_api
:members:
:undoc-members:
:show-inheritance:

tests.test\_benchmark module
----------------------------

.. automodule:: tests.test_benchmark
:members:
:undoc-members:
:show-inheritance:

tests.test\_errors module
-------------------------

.. automodule:: tests.test_errors
:members:
:undoc-members:
:show-inheritance:

tests.test\_h3\_utils module
----------------------------

.. automodule:: tests.test_h3_utils
:members:
:undoc-members:
:show-inheritance:

tests.test\_ingest module
-------------------------

.. automodule:: tests.test_ingest
:members:
:undoc-members:
:show-inheritance:

tests.test\_ingest\_cli module
------------------------------

.. automodule:: tests.test_ingest_cli
:members:
:undoc-members:
:show-inheritance:

tests.test\_module module
-------------------------

.. automodule:: tests.test_module
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: tests
:members:
:undoc-members:
:show-inheritance:
5 changes: 5 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
API Reference
=============

.. automodule:: space2stats.StatsTable
:members:
37 changes: 37 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
###############################################################################
# Auto-generated by `jupyter-book config`
# If you wish to continue using _config.yml, make edits to that file and
# re-generate this one.
###############################################################################
apidoc_module_dir = '../space2stats_api/src'
author = 'World Bank'
comments_config = {'hypothesis': False, 'utterances': False}
copyright = '2023'
exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_thebe', 'sphinx_comments', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinxcontrib.apidoc', 'sphinx_jupyterbook_latex', 'sphinx_multitoc_numbering']
external_toc_exclude_missing = True
external_toc_path = '_toc.yml'
html_baseurl = 'https://github.com/worldbank/DECAT_Space2Stats'
html_favicon = ''
html_last_updated_fmt = '%b %d, %Y'
html_logo = 'docs/images/logo.png'
html_show_copyright = False
html_sourcelink_suffix = ''
html_theme = 'sphinx_book_theme'
html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': '', 'jupyterhub_url': '', 'thebe': False, 'colab_url': ''}, 'path_to_docs': '', 'repository_url': 'https://github.com/worldbank/DECAT_Space2Stats', 'repository_branch': 'main', 'extra_footer': '<div>\n <b>All content (unless otherwise specified) is subject to the <a href="https://raw.githubusercontent.com/worldbank/template/main/LICENSE">World Bank Master Community License Agreement.</a></b>\n</div>\n', 'home_page_in_toc': True, 'announcement': '', 'analytics': {'google_analytics_id': ''}, 'use_repository_button': True, 'use_edit_page_button': True, 'use_issues_button': True}
html_title = ''
latex_engine = 'pdflatex'
myst_enable_extensions = ['colon_fence', 'dollarmath', 'linkify', 'substitution', 'tasklist']
myst_url_schemes = ['mailto', 'http', 'https']
nb_execution_allow_errors = True
nb_execution_cache_path = ''
nb_execution_excludepatterns = ['notebooks/*.ipynb']
nb_execution_in_temp = False
nb_execution_mode = 'off'
nb_execution_timeout = 30
nb_output_stderr = 'show'
numfig = True
pygments_style = 'sphinx'
suppress_warnings = ['myst.domains']
use_jupyterbook_latex = True
use_multitoc_numbering = True
Binary file added docs/images/GDF_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/WEE_LCA.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/WEE_PNG.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/boundary_comparison_VNM.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/geo-enhancement-pipeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Space2Stats
The Space2Stats program is designed to provide academics, statisticians, and other interested data scientists with easier access to regularly requested geospatial aggregate data. The primary deliverable is a database of geospatial aggregates at two official scales:
1. Official World Bank boundaries at admin level 2
2. A global database of h3 hexagons at level 6 (~36km2)

The Space2Stats program is funded by the World Bank's [Global Data Facility](https://www.worldbank.org/en/programs/global-data-facility), which is a World-Bank hosted global funding instrument for the world's most critical data impact opportunities.

```{image} images/GDF_logo.png
---
:alt: GDF
---
```
16 changes: 16 additions & 0 deletions docs/sub_tasks/admin_bounds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Official World Bank Boundaries
The WBG produces many datasets at the global scale, often in complex geospatial formats. These datasets need to be summarized and aggregated at a smaller administrative level to provide meaningful results – a process which requires a reliable and up-to-date set of global administrative boundaries.

The Global Administrative Boundaries subtask (P501733) of the Space2Stats program (P180913) seeks to obtain, disseminate, and update a new high-resolution global boundary dataset at Levels 0 (national), 1 (state/province), and 2 (district). Moving forward, the files will have documented versioning as well as a detailed and well-defined coding system so that the boundaries can be easily joined with tabular data. The licensing on the high-resolution files will be public, creating a global public good that can be used by other organizations in the international development community.

To illustrate the difference between the high and medium resolution products, the following images show the high resolution Administrative 2 boundaries (in blue, digitized at a 1:250,000 scale) and medium resolution (in red, digitized at a 1:1,000,000 scale). While acceptable for regional or global mapping, medium resolution is of substantively lower quality when viewing a small area. This is especially noteworthy when summarizing other global datasets by administrative area, as the lower-resolution boundaries can significantly affect the results.

```{image} ../images/boundary_comparison_VNM.png
---
:alt: Boundary comparison
---
Differences in administrative boundary resolution around Hanoi, Vietnam. High resolution is blue and medium is red
```
The leadership of this project is shared between the DECAT Global Operations Support Team (GOST) and the GCS Cartography Unit. With the amount of data that DECAT produces, the team has a vested interest in ensuring the boundary files needed for summarizing datasets are reliable. Meanwhile, the Cartography Unit currently holds the responsibility of maintaining and hosting the official WBG GAD and distributing it via the Development Data Hub (DDH).

In summer 2024, the contract for the production of the new high-resolution boundaries was awarded to IMA, a vendor with extensive experience in producing legally-approved boundary datasets for international use. The draft dataset was delivered in October 2024, edited by the WBG’s legal department, and sent back to IMA for a few small edits. The final legally-approved dataset is expected by late November 2024. The boundaries will then be placed on DDH and made publicly available, while the team then focuses on the editing and update plan.
33 changes: 33 additions & 0 deletions docs/sub_tasks/geest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# GEEST - Assessing women's employment opportunities
[For complete project information, please click here](https://worldbank.github.io/GEEST/README.html)

With support from the [Canada Clean Energy and Forest Climate Facility (CCEFCFy)](https://www.worldbank.org/en/topic/climatechange/brief/canada-world-bank-clean-energy-and-forests-climate-facility), the [Geospatial Operational Support Team (GOST, DECSC)](https://worldbank.github.io/GOST) launched the project "Geospatial Assessment of Women Employment and Business Opportunities in the Renewable Energy Sector." The project proposes a novel methodology for mapping the enabling environments for women's employmenty. The goal is to inform new energy projects in client countries to support the advancement of women's economic empowerment while contributing to closing gender gaps in employment in the RE sector.

In addition to the methodology, the project has generated an geospatial open-source, QGIS tool for implementing the methodology. For more details, visit the GEEST project directly.

```{image} ../images/WEE_PNG.png
---
:alt: GEEST score
---
GEEST was used to calculate the enabling score in Comoros, Dominican Republic, and Papua New Guinea
```

Countries included in the project:

| AFRICA | LATIN AMERICA AND CARIBBEAN | EAST ASIA AND PACIFIC | SOUTH ASIA |
| --- | --- | --- | --- |
| Cabo Verde | Antigua and Barbuda | Federated States of Micronesia | Maldives |
| Comoros | Belize | Fiji  | |
| Guinea-Bissau | Dominica | Kiribati | |
| Mauritius | Dominican Republic | Marshall Islands | |
| São Tomé and Príncipe | Grenada | Nauru | |  
| | Guyana | Niue | |  
| | Haiti | Palau | |  
| | Jamaica | Papua New Guinea | |  
| | St. Lucia | Samoa | |  
| | St. Vincent and Grenadines | Solomon Islands | |
| | Suriname | Timor-Leste | |  
| | | Tonga | |  
| | | Tuvalu | |  
| | | Vanuatu | |

17 changes: 17 additions & 0 deletions docs/sub_tasks/geo_enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Geospatial Enhancement of Surveys
[For more project information, please visit project website](https://worldbank.github.io/DECAT_HH_Geovariables/README.html)

This repository contain code and documentation about a collection of activities whose overarching goal is to add geospatial variables to locations from household surveys. For example, given a completed household survey in a country, we can generate anonymized household level coordinates (or enumeration area level coordinates which will be centroids) and link them with variables coming from geospatial data such as precipitation, vegetation indices and more which are otherwise not avaibale in the survey itself. Thus, geoenhancement is a way to enrich survey data with geospatial variables so that analysts can conduct more extended analysis. The repository provides the following:

Survey geo-enhacment process. In-depth information about how the geovariables are generated, rationale for selection of data sources and other design decisions. In addition, we also document best practices for this type of data processing.

Data generation for specific surveys. All the required documentation about each survey which has gone through this geo-enhancement is fully covered in this repo. This includes what geovariables were generated, where to find the output geovariables and more.

Spatial anonymization. As you will note from the survey geo-enhancement process, the survey coordinates need to be anonymized first before they are used in the ge-enhancement process and the associated geovariables publicly disseminated. As such, the work covered in this repository included development of tools for robust spatial anonymization. A Python package: [spatial-anoanonymization] (worldbank/Spatial-Anonymization) for this prupose is being developed. In this regard, information about this package and other tools for spatial anonymization and bets practices will also be provided.

```{image} ../images/geo-enhancement-pipeline.png
---
:alt: Geo-enhancement process
---
Geo-enhancement workflow
```
2 changes: 2 additions & 0 deletions docs/sub_tasks/sub_national_welfare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Sub-national Welfare
Lorem Ipsum
Loading

0 comments on commit 2064e13

Please sign in to comment.