python

Python Utilities and Components

Requirements:

• Python 3.x > 3.8
• FlatBuffers 2.x > 2.0.0 Compiler accessible on the path

Setup:

For Unix-based systems

• Ensure you've installed flatc and ran .\codegen.sh as described in the parent directory README
• Install gdal (using brew you can do this with brew install gdal)
• Using a version of Python greater than 3.8, run:
  • python -m venv venv
  • . .\venv\bin\activate
  • python -m pip install -r requirements.lock

For Windows

• It's recommended to install Windows Subsystem for Linux (WSL) and follow the instructions above, it might be possible to run some of Python modules on Windows however the spatial dependencies like GDAL can be difficult to get working and are currently not tested or supported for this project.

Usage

• Activate the virtual environment with . .\venv\bin\activate

• Run: jupyter-lab

• Follow instructions in either:

  • Synthetic Environment Generation README
  • Report Analysis README

Development

Updating Python Packages

• Update the versions of the top-level dependencies in requirements.txt
• Create a fresh virtual environment
• python -m pip install -r requirements.txt not requirements.lock
• python -m pip freeze > requirements.lock