Merge pull request #1 from alan-turing-institute/init-and-set-up-modules-structure

Init package and set up modules structure

Author: sgreenbury

.github/workflows/ci.yaml

@@ -0,0 +1,54 @@
+name: ci
+
+on: 
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    if: github.event.pull_request.draft == false || github.event_name == 'push'
+    name: Test on ${{ matrix.os }} with Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        # only run for MSV Python 3.10 on PRs, but all versions on pushes to main
+        python-version: ${{ github.event_name == 'push' && fromJSON('["3.10", "3.11", "3.12"]') || fromJSON('["3.10"]') }}
+    env:
+      TURN_OFF_MPS_IF_RUNNING_CI: 1
+      MPLBACKEND: Agg
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-suffix: ${{ runner.os }}-${{ matrix.python-version }}
+          activate-environment: true
+
+      - name: Install dependencies
+        run: |
+          uv sync --extra dev
+
+      - name: Test with pytest
+        run: |
+          # stop pytest after 3 failures to save CI time
+          uv run pytest --maxfail=3 --cov-report=xml --cov-report=html

.gitignore

@@ -0,0 +1,6 @@
+notebooks/
+__pycache__/
+.pytest_cache/
+dist/
+.venv/
+*.egg-info/

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.4
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      types_or: [ python, pyi ]
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [ python, pyi ]
+- repo: https://github.com/RobertCraigie/pyright-python
+  rev: v1.1.405
+  hooks:
+  - id: pyright
+# - repo: https://github.com/kyanan/nbstripout
+#   rev: 0.8.1
+#   hooks:
+#   - id: nbstripout
+#     exclude: ^case_studies/

.python-version

@@ -0,0 +1 @@
+3.12

pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "auto-x"
+version = "0.1.0"
+description = "Spatiotemporal forecasting"
+readme = "README.md"
+authors = [
+    { name = "AI for Physical Systems Team at The Alan Turing Institute", email = "ai4physics@turing.ac.uk" },
+]
+requires-python = ">=3.10,<3.13"
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "ipykernel>=7.1.0",
+    "pytest>=9.0.1",
+    "pytest-cov>=7.0.0",
+    "ruff==0.14.4",
+    "pyright==1.1.405",
+    "pre-commit>=4.4.0",
+]
+
+[project.scripts]
+auto-x = "auto_x:main"
+
+[build-system]
+requires = ["uv_build>=0.8.15,<0.9.0"]
+build-backend = "uv_build"

src/auto_x/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from auto-x!")