supy

SUEWS

This is a public repo for SUEWS source code and documentation.

Documentation

• Documentation site: https://suews.readthedocs.io/

• Documentation source: docs folder in this repo

Quick Start

For users who want to run SUEWS simulations:

• Install from PyPI (simplest):

  pip install supy
  

• Run a simulation:

  suews-run /path/to/config.yml
  

For developers, see the Developer Note section below.

Developer Note

[!NOTE] the following is deprecated and will be updated

Development Environment

Claude Code Integration

For enhanced development productivity, SUEWS includes integration with Claude Code in a containerised environment:

• Setup Guide: See claude-dev/README.md for complete setup instructions
• Quick Start:
  • Workspace Manager (recommended): ./claude-dev/claude.sh start myproject
  • Direct Setup: ./claude-dev/setup-claude-dev.sh from repository root
• Features: Intelligent code assistance, automated testing, British academic standards, multi-workspace support
• Benefits: Isolated environment, reproducible development, AI-powered debugging, parallel project development

Traditional Development

For local development without containerisation, follow these steps:

Prerequisites

Essential Tools:

• Fortran Compiler: gfortran (≥ 9.3.0) or Intel ifort
  • macOS: brew install gcc
  • Ubuntu/Debian: sudo apt-get install gfortran
  • Windows: Use WSL or MinGW-w64
• Version Control: git
• Package Manager: mamba (faster than conda)

  # Install mambaforge (if not already installed)
  curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
  bash Miniforge3-$(uname)-$(uname -m).sh
  

Recommended Tools:

• VS Code with extensions:
  • Modern Fortran
  • Python
  • GitHub Copilot (free for academic use)
• WSL (Windows users)

Setup Steps

• Clone the repository:

  git clone https://github.com/UMEP-dev/SUEWS.git
  cd SUEWS
  

• Initialise submodules (required for SPARTACUS dependency):

  git submodule init
  git submodule update
  

  Note: If permission denied, configure SSH for GitHub

• Create development environment:

  mamba env create -f env.yml
  

  This creates suews-dev environment with all required packages.

• Activate environment:

  mamba activate suews-dev
  

• Build SUEWS:

  # Quick development build (recommended)
  make dev
  
  # Or full build with tests
  make
  

• Verify installation:

  pip show supy
  suews-run --help
  

Development Workflow

• Build commands:

  make dev          # Fast development build
  make              # Full build with tests
  make test         # Run test suite only
  make clean        # Clean build artifacts
  make wheel        # Build distribution wheels
  make docs         # Build documentation
  make livehtml     # Live documentation preview
  

• Environment management:

  make help         # Show all available commands
  make deactivate   # Show deactivation command
  

• Common issues:

  • Build conflicts: Run make clean before rebuilding
  • Import errors: Ensure you're in the suews-dev environment
  • Permission errors on Windows: Right-click project folder → Properties → Security → Edit → Everyone → Allow

Project Structure

SUEWS/
├── src/
│   ├── suews/          # Fortran physics engine
│   ├── supy/           # Python interface
│   └── supy_driver/    # F2Py wrapper
├── test/               # Test suite
├── docs/               # Documentation source
├── env.yml             # Development environment
└── Makefile            # Build commands

Debugging with GDB

GDB is a generic debugging tool used along with gfortran. Here are some tips to debug SUEWS code:

GDB on macOS

Recent macOS (since High Sierra) introduces extra security procedures for system level operations that makes installation GDB more tedious than before. The best practice, in TS's opinion, to avoid hacking your macOS, is to use Linux docker images with gfortran & gdb installations: e.g., alpine-gfortran (otherwise, this guide might be useful for installation of GDB on macOS; also run set startup-with-shell off inside GDB before run the debuggng process)

Once the docker image is installed, simply run this from the SUEWS root folder for debugging:

 docker run --rm -it -v $(pwd):/source sunt05/alpine-gfortran /bin/bash

which will mount the current SUEWS directory to docker's path /source and enter the interactive mode for debugging.

debugging with GDB

• enable the debugging related flags in Makefile under SUEWS-SourceCode by removing the # after the equal sign =:

FCNOOPT = -O0
FFLAGS = -O3 $(STATIC) $(FCDEBUG) -Wall -Wtabs -fbounds-check -cpp \
					-Wno-unused-dummy-argument -Wno-unused-variable

• fully clean and recompile SUEWS:

make clean; make

• copy the recompiled SUEWS binary into your SUEWS testing folder (e.g., Test/BaseRun/2019a) and load it into GDB:

gdb SUEWS

run

then you should have stack info printed out by GDB if any runtime error occurs.

More detailed GDB tutorial can be found here.

Questions

• Please raise issues for questions in the development so our progress can be well managed.