Inland Consequences

This project aims to create a unified methodology for consequence modeling that seamlessly integrates both coastal and inland approaches, providing adaptable and efficient solutions for a wide range of scenarios. For more details on this project, please view our Consequences Solution documentation.

Prerequisites

Install uv if you haven't already:

Linux/macOS:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

For other installation methods, see the uv documentation.

Environment and Docs Setup

1. Create a Python virtual environment and install dependencies

uv sync --all-packages

2. Run tests

uv run pytest -q

3. Run the local mkdocs server.

uv run mkdocs serve

Optional Setup - Markdown Formatting Pre-Commit Hook

To set up a pre-commit hook for mdformat to automatically format Markdown files within the repository:

(venv-inland) $ pre-commit install