Site suitability

Introduction

The aim of this project is to develop software for a company producing rock aggregates to help them explore three key factors for building a plant in the UK. The software will use raster data to analyse the suitability of each factor for the location of the plant. By assigning weights to each factor and adding up the weighted factors, the software will produce a comprehensive suitability map. A graphical user interface (GUI) is provided to allow the user to easily select the factor weights and view the visualisation of the suitability score in real time. Finally, the software saves a raster of the results as a file for further analysis and decision making.

Installation

1. Install Python 3.8 or later. You can download and install it from the official Python website:https://www.python.org/downloads/.
2. To access the project directory and install the required dependencies:

cd src
pip install -r requirements.txt

Project structure

Site-suitability/
│
├── data/
│   ├── input/
│   │   ├── geology.txt
│   │   ├── population.txt
│   │   └── transport.txt
│   └── output/
│
├── src/
│   ├── main.py 
│   ├── requirements.txt
│   └── my_modules/
│   │   ├── GUI.py
│   │   ├── io.py
│   │   └── raster.py
│   └── test  
│       └── test_raster.py
└── README.md

Document description

• geology.txt - Raster data for geology
• population.txt - Raster data for population
• transport.txt - Raster data for transport
• main.py - The entry point to the application, containing the Tkinter main loop.
• requirements.txt - Lists the required packages for the application.
• GUI.py - Contains the GUI implementation for the application.
  • createWidget: Creates the menus and bindings for the main tkinter window.
  • openfile: Prompts the user to select raster files to load and displays them on the canvas.
  • suitability: Displays a window with a slider for each loaded raster to adjust its weight, and displays a final raster calculated as the weighted sum of the loaded rasters. The user can add rasters from the window. If the "judge" parameter is True, it prompts the user to select raster files to load. If the "judge" parameter is False, add the raster
  • plot: Plots the loaded rasters on the canvas.
  • creatRaster: Creates a Raster object for each file path in the "files" parameter and appends them to the raster_list attribute. If the "judge" parameter is True, it empties the raster_list before appending the new rasters.
  • update: Calculates the new raster based on the updated weights of each raster and updates the canvas display accordingly.Bind the slider and input box to this function, which is triggered when the slider and input box values change.
  • destroy: Destroys all tkinter widgets.
  • savefile: Prompts the user to select a file to save the processed raster as a text file.
  • saveimage: Prompts the user to select a file to save the processed raster as a image.
  • addfile: Prompts the user to select additional raster files to load and adds them to the window.
  • exit: Closes the tkinter window and quits the application.
  • open_readme: Opens the README.md file in the default system text editor
• io.py - Contains functions for reading and writing data.
  • read_data：Reads the csv data from the address passed and stores the data in a list for return.
  • write_data: Write the passed data by line in the passed address.
• raster.py - Contains the Raster class and associated functions for raster manipulation.
  • multiply: Multiplies each cell in the raster by the given weight and returns a new Raster instance.
  • normalize: Normalizes the raster data by scaling the values to the range [0, 255].
  • add_rasters: Adds the corresponding cells of a list of Raster instances and returns a new Raster instance. If the dimensions of the rasters do not match, returns None.
  • check_dimensions: Check if all the rasters in the list have the same dimensions.
  • check_data_integrity: Checks the integrity of the raster data.
• test_raster.py - Contains unit tests for the Raster class.
• README.md - The documentation for the project.

Use

Run the application:

python main.py

GUI interface use

1. Show raster images: Select one or more text files by clicking on 'Show raster' under 'File' in the menu bar, click on the 'Open' button to read the files and the raster images will be displayed side by side in the canvas area.
2. Generation of site suitability maps based on weights: Under the 'Show raster' page click on 'Visualise the suitability' or under 'File' click on 'Visualise the suitability' to select the file with the impact factor. After selecting the file you will see an image of the corresponding factor on the canvas as well as an image of the site suitability. By adjusting the sliders for the corresponding factors you can change the weights corresponding to each factor and reweight the site suitability image. There are also three buttons at the bottom, 'Save Image', 'Save File' and 'Add'. They correspond to the functions of saving the generated site suitability image (.jpg , .png and .svg formats are available), saving a text file (.txt and .csv formats are available) and adding a factor.
3. Open the readme file: The Readme file can be opened by clicking on 'Readme' under 'Help' to view the file for help on how to use it.
4. Exit: The GUI page can be exited by clicking on 'Exit' under 'File'.
5. Shortcut keys:

• Ctrl+s: Show raster
• Ctrl+v: Visualise the suitability
• Ctrl+e: Exit
• Ctrl+r: Readme

Contributing and Maintenance

If you'd like to contribute to this project or report any bugs, please create an issue on the GitHub repository or submit a pull request. The project is maintained by Shihong He.

License

This project is licensed under the MIT License. See the LICENSE file for more information.