pre-commit all

Author: SimonBlanke

Makefile

@@ -1,37 +1,151 @@
-build:
-	python -m build
+# =============================================================================
+# Surfaces Makefile
+# =============================================================================
 
-install: build
-	pip install dist/*.whl
+.PHONY: build install uninstall test lint format check clean help
 
-uninstall:
-	pip uninstall -y surfaces
-	rm -fr build dist *.egg-info
+# =============================================================================
+# Installation
+# =============================================================================
+
+install-editable:
+	pip install -e .
 
 install-dev:
 	pip install -e ".[dev]"
 
 install-test:
 	pip install -e ".[test]"
 
+install-test-minimal:
+	pip install -e ".[test-minimal]"
+
 install-build:
 	pip install build
 
-install-editable:
+reinstall-editable:
+	pip uninstall -y surfaces || true
 	pip install -e .
 
+# =============================================================================
+# Building
+# =============================================================================
+
+build:
+	python -m build
+
+install: build
+	pip install dist/*.whl
+
+uninstall:
+	pip uninstall -y surfaces || true
+	rm -fr build dist *.egg-info
+
 reinstall: uninstall install
 
-reinstall-editable: uninstall install-editable
+# =============================================================================
+# Testing
+# =============================================================================
+
+py-test:
+	python -m pytest -x -p no:warnings tests/
 
 test-examples:
-	cd tests; \
-		python _test_examples.py
+	cd tests && python _test_examples.py
 
-py-test:
-	python -m pytest -x -p no:warnings tests/; \
+test: py-test test-examples
+
+# Test with minimal dependencies (no sklearn, no viz)
+test-minimal:
+	python -m pytest -x -p no:warnings tests/test_1d_functions.py tests/test_2d_functions.py tests/test_nd_functions.py
+
+# Test with coverage
+test-cov:
+	python -m pytest --cov=surfaces --cov-report=term-missing --cov-report=xml -p no:warnings tests/
+
+# =============================================================================
+# Code Quality
+# =============================================================================
+
+lint:
+	ruff check .
+
+lint-fix:
+	ruff check --fix .
+
+format:
+	ruff format .
+
+format-check:
+	ruff format --check .
+
+check: lint format-check
 
-test:  py-test test-examples
+fix: lint-fix format
+
+# =============================================================================
+# Pre-commit
+# =============================================================================
+
+pre-commit-install:
+	pre-commit install
+
+pre-commit-all:
+	pre-commit run --all-files
+
+pre-commit-update:
+	pre-commit autoupdate
+
+# =============================================================================
+# Data Collection
+# =============================================================================
 
 database:
 	python -m collect_search_data.py
+
+# =============================================================================
+# Cleanup
+# =============================================================================
+
+clean:
+	rm -fr build dist *.egg-info
+	rm -fr .pytest_cache .ruff_cache .coverage coverage.xml
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete
+
+# =============================================================================
+# Help
+# =============================================================================
+
+help:
+	@echo "Surfaces Development Commands"
+	@echo "=============================="
+	@echo ""
+	@echo "Installation:"
+	@echo "  install-editable      Install package in editable mode"
+	@echo "  install-dev           Install with dev dependencies"
+	@echo "  install-test          Install with test dependencies (full)"
+	@echo "  install-test-minimal  Install with minimal test dependencies"
+	@echo ""
+	@echo "Testing:"
+	@echo "  test                  Run all tests"
+	@echo "  py-test               Run pytest only"
+	@echo "  test-minimal          Run tests for core functions (no optional deps)"
+	@echo "  test-cov              Run tests with coverage"
+	@echo ""
+	@echo "Code Quality:"
+	@echo "  lint                  Check code with ruff"
+	@echo "  lint-fix              Fix linting issues"
+	@echo "  format                Format code with ruff"
+	@echo "  format-check          Check code formatting"
+	@echo "  check                 Run all checks (lint + format)"
+	@echo "  fix                   Fix all issues (lint + format)"
+	@echo ""
+	@echo "Pre-commit:"
+	@echo "  pre-commit-install    Install pre-commit hooks"
+	@echo "  pre-commit-all        Run pre-commit on all files"
+	@echo "  pre-commit-update     Update pre-commit hooks"
+	@echo ""
+	@echo "Other:"
+	@echo "  build                 Build package"
+	@echo "  clean                 Remove build artifacts"

README.md

@@ -25,7 +25,7 @@
 ### Use Cases
 
 - **Algorithm Development**: Test new optimization algorithms against established benchmarks
-- **Performance Comparison**: Compare different optimizers on standardized problem sets  
+- **Performance Comparison**: Compare different optimizers on standardized problem sets
 - **Research Publications**: Use well-known test functions with consistent implementations
 - **Educational Purposes**: Learn optimization concepts with visual and mathematical examples
 - **Hyperparameter Tuning**: Benchmark autoML and hyperparameter optimization methods
@@ -40,7 +40,7 @@
 <table style="width:100%">
   <tr>
     <th> <b>Objective Function</b> </th>
-    <th> <b>Heatmap</b> </th> 
+    <th> <b>Heatmap</b> </th>
     <th> <b>Surface Plot</b> </th>
   </tr>
   <tr>
@@ -125,7 +125,7 @@ Import from `surfaces.test_functions.mathematical`:
 Import from `surfaces.test_functions.machine_learning`:
 
 - `KNeighborsClassifierFunction` - K-nearest neighbors classification
-- `KNeighborsRegressorFunction` - K-nearest neighbors regression  
+- `KNeighborsRegressorFunction` - K-nearest neighbors regression
 - `GradientBoostingRegressorFunction` - Gradient boosting regression
 
 ### Common Interface
@@ -175,7 +175,7 @@ print(search_space.keys())  # dict_keys(['n_neighbors', 'algorithm', 'cv', 'data
 # Evaluate function
 params = {
     'n_neighbors': 5,
-    'algorithm': 'auto', 
+    'algorithm': 'auto',
     'cv': 3,
     'dataset': knn_func.search_space()['dataset'][0]
 }
@@ -190,12 +190,11 @@ from surfaces.test_functions.mathematical import SphereFunction
 
 # Create functions with different dimensionalities
 sphere_1d = SphereFunction(n_dim=1)
-sphere_3d = SphereFunction(n_dim=3) 
+sphere_3d = SphereFunction(n_dim=3)
 sphere_10d = SphereFunction(n_dim=10)
 
 # Each has appropriate search space
 print(sphere_1d.search_space().keys())   # dict_keys(['x0'])
 print(sphere_3d.search_space().keys())   # dict_keys(['x0', 'x1', 'x2'])
 print(sphere_10d.search_space().keys())  # dict_keys(['x0', 'x1', ..., 'x9'])
 ```
-