Setting Up Your Development Environment

There are a few requirements needed for easily running the test suite and building the documentation locally.

Prerequisites

• uv
• Python 3.10 or newer (3.10, 3.11, or 3.12 recommended) (can be handled by uv)
• Git
• Ollama

Development Environment Setup

1. Clone the repository

      git clone https://github.com/TutteInstitute/toponymy.git
      cd toponymy

2. Install Python dependencies

      # Install the package in development mode
      uv sync --extra dev --extra example-notebooks

      # For documentation development (read the docs)
      uv sync --extra dev --extra example-notebooks --extra doc

3. Install Ollama: See https://ollama.com/download and ollama pull llama3.2:1b. Optional, but needed for running the full test suite locally.