svc-processing 0.1.1__tar.gz → 0.1.2__tar.gz

{svc_processing-0.1.1 → svc_processing-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: svc-processing
-Version: 0.1.1
+Version: 0.1.2
 Summary: Pure-Python SVC HR-1024i hyperspectral .sig processing pipeline
 Author: Gold Lab (GrapeSPEC project), Cornell University
 Author-email: Cole Regnier <nr466@cornell.edu>
@@ -65,6 +65,20 @@ Generated outputs (gitignored): `pipeline_outputs/sig_processed/<run>/`, `pipeli
 > New to the pipeline? [`TUTORIAL.md`](TUTORIAL.md) starts with the interactive
 > Jupyter notebook (the gentle path) and has an advanced track for the CLI below.
 
+**Installed from PyPI, in a new project folder** (no clone of this repo needed):
+
+```bash
+python3.11 -m venv .venv
+source .venv/bin/activate
+python -m pip install svc-processing
+
+svc-pipeline --init-config   # writes a starter config/config.json here
+# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
+svc-pipeline
+```
+
+**Working from a clone of this repo** (config/config.json already exists):
+
 ```bash
 python3.11 -m venv .venv
 source .venv/bin/activate

{svc_processing-0.1.1 → svc_processing-0.1.2}/README.md

@@ -32,6 +32,20 @@ Generated outputs (gitignored): `pipeline_outputs/sig_processed/<run>/`, `pipeli
 > New to the pipeline? [`TUTORIAL.md`](TUTORIAL.md) starts with the interactive
 > Jupyter notebook (the gentle path) and has an advanced track for the CLI below.
 
+**Installed from PyPI, in a new project folder** (no clone of this repo needed):
+
+```bash
+python3.11 -m venv .venv
+source .venv/bin/activate
+python -m pip install svc-processing
+
+svc-pipeline --init-config   # writes a starter config/config.json here
+# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
+svc-pipeline
+```
+
+**Working from a clone of this repo** (config/config.json already exists):
+
 ```bash
 python3.11 -m venv .venv
 source .venv/bin/activate

{svc_processing-0.1.1 → svc_processing-0.1.2}/pipeline/cli.py

@@ -50,6 +50,11 @@ def _parse_args() -> argparse.Namespace:
         action="store_true",
         help="Enable verbose logging before and after each processing step",
     )
+    parser.add_argument(
+        "--init-config",
+        action="store_true",
+        help="Write a starter config/config.json in the current directory and exit.",
+    )
     return parser.parse_args()
 
 
@@ -61,6 +66,13 @@ def main() -> None:
     # working directory so the installed `svc-pipeline` command works from any
     # directory. Absolute paths in the config are always honoured as-is.
     base_dir = Path.cwd()
+
+    if args.init_config:
+        target = RunConfig.write_starter_config(base_dir)
+        print(f"Wrote starter config: {target.resolve()}")
+        print('Edit "sig_input_dir" to point at your .sig data, then run: svc-pipeline')
+        return
+
     run_config = RunConfig.load(base_dir, str(args.config), logger)
     run_config.ensure_no_placeholder(args.input_dir)
 

{svc_processing-0.1.1 → svc_processing-0.1.2}/pipeline/run_config.py

@@ -34,6 +34,24 @@ _PARITY_DEFAULTS: dict[str, Any] = {
 
 _PLACEHOLDER = "<PATH_TO_SIG_INPUT_ROOT>"
 
+# Starter template written by `svc-pipeline --init-config`. Mirrors the
+# repo's own config/config.json — keep the two in sync if either changes.
+_STARTER_CONFIG_TEMPLATE: dict[str, Any] = {
+    "sig_input_dir": _PLACEHOLDER,
+    "process_all_subdirs": True,
+    "processed_dir": "sig_processed",
+    "resampled_dir": "sig_resampled",
+    "output_dir": "pipeline_outputs",
+    "summary_csv_name": "processed_sig_summary.csv",
+    "merged_csv_name": "merged_spectra.csv",
+    "end_line_overrides": {},
+    "instrument": {
+        "bronze": {"end_line": "2520.4", "serial": "2212118"},
+        "silver": {"end_line": "2517.9", "serial": "1202103"},
+    },
+    "processing": dict(_PARITY_DEFAULTS),
+}
+
 
 def _resolve_under(base: Path, value: str) -> Path:
     """Resolve ``value`` against ``base`` unless it is already absolute."""
@@ -87,6 +105,25 @@ class RunConfig:
         logger.info("Using config: %s", path)
         return cls(data, path=path, base_dir=base_dir, logger=logger)
 
+    @classmethod
+    def write_starter_config(cls, base_dir: Path, *, filename: str = "config.json") -> Path:
+        """Write a starter ``config/<filename>`` under ``base_dir`` and return its path.
+
+        Refuses to overwrite an existing file, so re-running this never clobbers
+        edits you've already made.
+        """
+        target = base_dir / "config" / filename
+        if target.exists():
+            raise SystemExit(
+                f"{target} already exists — not overwriting.\n"
+                f"  Edit it directly, or remove it first to regenerate the starter template."
+            )
+        target.parent.mkdir(parents=True, exist_ok=True)
+        with target.open("w") as handle:
+            json.dump(_STARTER_CONFIG_TEMPLATE, handle, indent=2)
+            handle.write("\n")
+        return target
+
     @staticmethod
     def _resolve_path(base_dir: Path, value: str) -> Path:
         """Resolve a run-config argument with friendly fallbacks.

{svc_processing-0.1.1 → svc_processing-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "svc-processing"
-version = "0.1.1"
+version = "0.1.2"
 description = "Pure-Python SVC HR-1024i hyperspectral .sig processing pipeline"
 readme = "README.md"
 requires-python = ">=3.11"

{svc_processing-0.1.1 → svc_processing-0.1.2}/svc_processing.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: svc-processing
-Version: 0.1.1
+Version: 0.1.2
 Summary: Pure-Python SVC HR-1024i hyperspectral .sig processing pipeline
 Author: Gold Lab (GrapeSPEC project), Cornell University
 Author-email: Cole Regnier <nr466@cornell.edu>
@@ -65,6 +65,20 @@ Generated outputs (gitignored): `pipeline_outputs/sig_processed/<run>/`, `pipeli
 > New to the pipeline? [`TUTORIAL.md`](TUTORIAL.md) starts with the interactive
 > Jupyter notebook (the gentle path) and has an advanced track for the CLI below.
 
+**Installed from PyPI, in a new project folder** (no clone of this repo needed):
+
+```bash
+python3.11 -m venv .venv
+source .venv/bin/activate
+python -m pip install svc-processing
+
+svc-pipeline --init-config   # writes a starter config/config.json here
+# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
+svc-pipeline
+```
+
+**Working from a clone of this repo** (config/config.json already exists):
+
 ```bash
 python3.11 -m venv .venv
 source .venv/bin/activate

{svc_processing-0.1.1 → svc_processing-0.1.2}/tests/test_cli.py

@@ -73,6 +73,36 @@ def test_main_input_dir_override_bypasses_config_input_and_placeholder(
     assert "not produced" in captured.out
 
 
+def test_main_init_config_writes_starter_and_exits(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    monkeypatch.chdir(tmp_path)
+    monkeypatch.setattr(sys, "argv", ["svc-pipeline", "--init-config"])
+
+    main()
+
+    written = tmp_path / "config" / "config.json"
+    assert written.is_file()
+    assert json.loads(written.read_text())["sig_input_dir"] == "<PATH_TO_SIG_INPUT_ROOT>"
+    assert str(written.resolve()) in capsys.readouterr().out
+
+
+def test_main_init_config_refuses_to_overwrite_existing(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.chdir(tmp_path)
+    existing = tmp_path / "config" / "config.json"
+    existing.parent.mkdir()
+    existing.write_text('{"already": "here"}')
+    monkeypatch.setattr(sys, "argv", ["svc-pipeline", "--init-config"])
+
+    with pytest.raises(SystemExit, match="already exists"):
+        main()
+
+
 def test_main_exits_on_placeholder_without_input_dir_override(
     tmp_path: Path,
     monkeypatch: pytest.MonkeyPatch,

{svc_processing-0.1.1 → svc_processing-0.1.2}/tests/test_run_config.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 import logging
 from pathlib import Path
 
@@ -21,6 +22,26 @@ def test_resolve_path_finds_bare_config_name(tmp_path: Path) -> None:
     assert RunConfig._resolve_path(tmp_path, "demo") == config_path
 
 
+def test_write_starter_config_creates_config_json_with_placeholder(tmp_path: Path) -> None:
+    target = RunConfig.write_starter_config(tmp_path)
+
+    assert target == tmp_path / "config" / "config.json"
+    data = json.loads(target.read_text())
+    assert data["sig_input_dir"] == "<PATH_TO_SIG_INPUT_ROOT>"
+    assert data["processing"]["band_min"] == 400
+
+
+def test_write_starter_config_refuses_to_overwrite_existing(tmp_path: Path) -> None:
+    existing = tmp_path / "config" / "config.json"
+    existing.parent.mkdir()
+    existing.write_text('{"already": "here"}')
+
+    with pytest.raises(SystemExit, match="already exists"):
+        RunConfig.write_starter_config(tmp_path)
+
+    assert json.loads(existing.read_text()) == {"already": "here"}
+
+
 def test_placeholder_guard_exits_with_guidance(tmp_path: Path) -> None:
     config_path = tmp_path / "config.json"
     config = RunConfig(