Merge pull request #15 from X-ray-interferometry/project-structure-overhaul

Project structure overhaul

Author: postoecker

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint
+# with a variety of Python versions
+# For more information see:
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Curtains
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install '.[dev]'
+      - name: Check formatting with ruff
+        run: |
+          ruff format --check
+      - name: Lint with ruff
+        run: |
+          ruff check

.gitignore

@@ -1,8 +1,4 @@
-__pycache__/
-
-.DS_Store
-/.DS_Store
-
+*.pyc
 .vscode/
 
 ignore/
@@ -13,10 +9,11 @@ random/
 output_data/
 results/
 
-curtains/models/*
-!curtains/models/arf.fits
-!curtains/models/rmf.fits
+src/curtains/models/*
+!src/curtains/models/arf.fits
+!src/curtains/models/rmf.fits
 
 *.egg-info/
 *.pdf
-simulation.py
+simulation.py
+src/curtains/version.py

pyproject.toml

@@ -1,17 +1,47 @@
-[build-system]
-requires = ["setuptools>=61.0"]
-
-build-backend = "setuptools.build_meta"
-
 [project]
 name = "curtains" 
-version = "0.0.1"
+dynamic = ["version"]
 description = "Simulation of X-ray interferometric observations"
 readme = "README.rst"
-requires-python = ">=3.8"
+authors = [
+    { name="Philipp Stoecker", email="p.o.stoecker@uva.nl" },
+]
+requires-python = ">=3.11"
 dependencies = [
-    
+    "numpy~=2.4",
+    "astropy~=7.2",
+    "matplotlib~=3.10",
+    "pandas~=3.0",
+    "scipy~=1.17",
+    "pillow~=12.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff~=0.13.2",
 ]
 
+[build-system]
+requires = ["setuptools>=77.0","setuptools_scm>=9.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+fallback_version = "0.1"
+write_to = "src/curtains/version.py"
+write_to_template = """
+# coding: utf-8
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = "{version}"
+__version_tuple__ = version_tuple = {version_tuple!r}
+__git_hash__ = "{scm_version.node}"
+__semantic_version__ = "{scm_version.tag}"
+"""
+
 [tool.setuptools.packages.find]
-where = ["curtains"]
+where = ["src"]
+
+[tool.ruff]
+# Ignore the auto-generated file
+include = ["src/curtains/*.py"]
+exclude = ["src/curtains/version.py"]