GOSTurban 1.0.0

Multiple functions, tools, and tutorials for calculating urbanization based on gridded population data

Quantifying urbanization

Urbanization is a foundational aspect of understanding the human condition, and has been a focus of economic, social, and development study for many years. This code repository is meant to centralize many of the urban analytics performed by the World Bank's Global Operational Support Team (GOST) in support of World Bank Group operations. There are numerous code examples in the notebooks folder including both tutorials and records of project implementations.

This repo includes a GitHub Pages and a Wiki for the documentation.

Installation

From PyPI

GOSTurban is available on PyPI and can installed using pip:

pip install GOSTurban

From Source

1. Clone or download this repository to your local machine. Then, navigate to the root directory of the repository:

   git clone https://github.com/worldbank/GOSTurban.git
   cd GOSTurban
   

2. Create a virtual environment (optional but recommended):

   python3 -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   

3. Install the package with dependencies:

pip install .

Developer Installation

Install the package in editable mode with all of the dependencies needed to run the tests and build the documentation locally:

pip install -e .[dev]

The -e flag stands for "editable," meaning changes to the source code will immediately affect the installed package.

License

This project is licensed under the MIT - see the LICENSE file for details.