Refocus project as a reproducible PhD research artifact

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: research-artifact-ci
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -r requirements.txt -r requirements-dev.txt
+      - run: python -m ruff check src tests
+      - run: python -m pytest
+      - run: python -m src.experiments --seeds 2 --jobs 40 --hours 72 --results-dir scratch/results --figures-dir scratch/figures

.gitignore

@@ -14,17 +14,12 @@ venv/
 .ipynb_checkpoints/
 
 # Large local data files
-data/*.csv
-data/*.xlsx
-data/*.parquet
-data/*.feather
-data/*.h5
-data/*.zip
+data/raw/
 data/external/
 data/processed/
 
-# Local outputs
-models/
+# Local scratch outputs. Curated results in results/ are versioned.
+scratch/
 
 # OS files
 .DS_Store

CITATION.cff

@@ -0,0 +1,15 @@
+cff-version: 1.2.0
+message: "If you use this research artifact, cite the software and the specific external datasets and papers used in your study."
+title: "Carbon and Water Aware Compute Scheduling Research Artifact"
+type: software
+authors:
+  - name: "Personal Project contributors"
+version: 0.2.0
+date-released: 2026-08-30
+repository-code: "https://github.com/drona23/Personal_Project"
+keywords:
+  - carbon-aware computing
+  - water-aware scheduling
+  - data centers
+  - reproducible research
+  - sustainable computing

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+Changes should preserve the research boundary and reproducibility guarantees.
+
+Before submitting a change:
+
+```bash
+python -m ruff check src tests
+python -m pytest
+python -m src.experiments
+```
+
+For a method or metric change, include:
+
+- a test that fails under the previous behavior;
+- an update to `docs/METHODOLOGY.md`;
+- regenerated seed-level and aggregate outputs;
+- an update to `docs/RESULTS.md` if interpretation changes;
+- a citation for any borrowed model, factor, or dataset;
+- a clear statement of new limitations.
+
+Do not add a dashboard or service layer to this branch. Keep application code in
+a separate repository or branch so the research artifact remains small and
+auditable.