https://github.com/ucl/bsp-isobenefit-qgis-plugin
Future Urban Growth (Isobenefit Cities)
https://github.com/ucl/bsp-isobenefit-qgis-plugin
Last synced: about 1 year ago
JSON representation
Future Urban Growth (Isobenefit Cities)
- Host: GitHub
- URL: https://github.com/ucl/bsp-isobenefit-qgis-plugin
- Owner: UCL
- License: agpl-3.0
- Created: 2022-11-04T17:11:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T21:11:51.000Z (almost 3 years ago)
- Last Synced: 2025-03-28T20:19:58.132Z (over 1 year ago)
- Language: Python
- Size: 627 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BSP Isobenefit Urbanism QGIS Plugin
QGIS plugin for Isobenefit Urbanism.
## QGIS Plugin Installation
To install the plugin in QGIS, enable the experimental plugins setting and then search for the "isobenefit" plugin.
## Original version
This work is an outgrowth of the [original work](https://github.com/mitochevole/isobenefit-cities) (forked to [BSP-isobenefit-original](https://github.com/UCL/BSP-isobenefit-original)) developed by Michele Voto and Luca D'Acci. This has subsequently been developed as part of the Future Urban Growth project at the Bartlett School of Planning.
## Website
A website providing a broad overview of this plugin can be found at [BSP-isobenefit-urbanism](https://github-pages.ucl.ac.uk/BSP-isobenefit-urbanism) with the associated repo located at [UCL/BSP-isobenefit-urbanism](https://github.com/UCL/BSP-isobenefit-urbanism).
## Plugin setup
QGIS does not yet have an integrated dependency management system. This means that certain of the dependencies required by this plugin have to be installed manually. Restart QGIS after the Python dependencies have been installed.
> If the below steps don't work, see [https://enmap-box.readthedocs.io/en/latest/usr_section/usr_installation.html#package-installer]() for additional context / ideas.
### Windows
1. From the Start menu, open OSGeo4W Shell.
2. Run `pip install numba==0.55.2`
3. If it complains that `rasterio` is missing, then install per `pip install rasterio`
### Mac
1. Open the Terminal application
2. Run `/Applications/QGIS.app/Contents/MacOS/bin/pip install numba==0.55.2`
3. If `rasterio` errors are encountered, then install the `rasterio` package as well.
### Linux
1. Open the terminal
2. Run `python3 -m pip install numba==0.55.2`
3. If `rasterio` errors are encountered, then install the `rasterio` package as well.
> NOTE: If you are missing the `shapely` or `fiona` packages, then you may also need to install these.
## Development Setup
- `brew install qt5 pyqt pdm qgis`
- `pdm install`
- add `.env` file with path appendages:
```bash
PYTHONPATH="${env:PYTHONPATH}:/Applications/Qgis.app/Contents/Resources/python/plugins:/Applications/Qgis.app/Contents/Resources/python"
```
## PB Tool
> Using `pb_tool` deploy doesn't seem to copy the files across, so using a softlink instead per next section.
- `pb_tool` uses a `pb_tool.cfg` file.
- Build the resources: `pb_tool compile`.
## Linking plugin file for local development
- On Windows: copy and paste the dev plugin folder (i.e. `isobenefit` folder) into the user's plugin directory, e.g. `/AppData/Roaming/QGIS/QGIS3/profiles/default/python/plugins`
- On Mac: Create a softlink from the development folder (`isobenefit`) to the QGIS plugins directory, this depends on the system, e.g.
- `ln -s /Users/gareth/dev/other/BSP-isobenefit-qgis-plugin/isobenefit/ '/Users/gareth/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins'`
- Restart QGIS.
## Zipping for distribution
If zipping the plugin directory on a mac, remove the `__MACOSX` directory:
`zip -d isobenefit.zip __MACOSX/\*`
## References
- [http://g-sherman.github.io/plugin_build_tool/](PB Tool)
- [https://qgis.org/pyqgis/3.28/](PyQgis)
- [https://gis-ops.com/qgis-3-plugin-tutorial-plugin-development-reference-guide/](Plugin Guide)
- [https://docs.qgis.org/testing/en/docs/pyqgis_developer_cookbook/index.html](Cookbook)
- [https://webgeodatavore.github.io/pyqgis-samples/index.html](Samples)
- [https://www.geodose.com/2021/03/netcdf-temporal-visualization-qgis.html](temporal range raster)
- [https://anitagraser.com](open source GIS ramblings)
- [https://docs.qgis.org/3.4/en/docs/user_manual/working_with_mesh/mesh_properties.html#what-s-a-mesh](mesh layers)