https://github.com/worldbank/gosturban
GOST's combined tools for urban analysis
https://github.com/worldbank/gosturban
urban-analytics worldbank-gost
Last synced: 6 months ago
JSON representation
GOST's combined tools for urban analysis
- Host: GitHub
- URL: https://github.com/worldbank/gosturban
- Owner: worldbank
- License: mit
- Created: 2020-11-03T12:38:23.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T22:54:54.000Z (over 1 year ago)
- Last Synced: 2024-04-14T12:20:01.917Z (over 1 year ago)
- Topics: urban-analytics, worldbank-gost
- Language: Jupyter Notebook
- Homepage: https://worldbank.github.io/GOSTurban/
- Size: 28.4 MB
- Stars: 7
- Watchers: 25
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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)](https://worldbank.github.io/GOST) in support of World Bank Group operations. There are numerous code examples in the [notebooks](https://github.com/worldbank/GOST_Urban/tree/main/notebooks) folder including both tutorials and records of project implementations.
This repo includes a [GitHub Pages](https://worldbank.github.io/GOSTurban/README.html) and a [Wiki](https://github.com/worldbank/GOST_Urban/wiki) for the documentation.
## Installation
### From PyPI
**GOSTurban** is available on [PyPI](https://pypi.org/project/GOSTurban/) and can installed using `pip`:
```shell
pip install GOSTurban
```
### From Source
1. Clone or download this repository to your local machine. Then, navigate to the root directory of the repository:
```shell
git clone https://github.com/worldbank/GOSTurban.git
cd GOSTurban
```
2. Create a virtual environment (optional but recommended):
```shell
python3 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install the package with dependencies:
```shell
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:
```shell
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**](https://opensource.org/license/mit) - see the [LICENSE](LICENSE) file for details.