svc-processing 0.1.3__tar.gz → 0.1.5__tar.gz

{svc_processing-0.1.3 → svc_processing-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: svc-processing
-Version: 0.1.3
+Version: 0.1.5
 Summary: Pure-Python SVC HR-1024i hyperspectral .sig processing pipeline
 Author: Gold Lab (GrapeSPEC project), Cornell University
 Author-email: Cole Regnier <nr466@cornell.edu>
@@ -20,6 +20,7 @@ Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: scipy
 Provides-Extra: demo
+Requires-Dist: ipykernel; extra == "demo"
 Requires-Dist: matplotlib; extra == "demo"
 Requires-Dist: nbclient; extra == "demo"
 Requires-Dist: nbconvert; extra == "demo"
@@ -77,14 +78,28 @@ svc-pipeline --init-config   # command name — different from the package name
 svc-pipeline
 ```
 
-**Working from a clone of this repo** (config/config.json already exists):
+**Working from a clone of this repo** (config/config.json already exists) — run the
+setup script once, then activate the environment it created:
+
+```bash
+./setup.sh            # creates .venv and installs the project + notebook tools
+# ./setup.sh --dev    # add the test & lint tools for development
+
+source .venv/bin/activate          # macOS / Linux
+# .venv\Scripts\activate           # Windows PowerShell
+
+# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
+svc-pipeline config.json
+```
+
+The script always installs into *this* repo's `.venv` no matter which folder you run
+it from, so it avoids the "Directory '.' is not installable" and "No module named …"
+errors that come from being in the wrong directory. Prefer to do it by hand?
 
 ```bash
 python3.11 -m venv .venv
 source .venv/bin/activate
 python -m pip install -e ".[dev,demo]"
-
-# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
 svc-pipeline config.json
 ```
 
@@ -197,6 +212,7 @@ The most-used entry points (all importable from their concrete modules — `pipe
 ```python
 from pipeline.sig_processor import SigFileProcessor   # truncation + instrument inspection
 from pipeline.resampler      import process_sig_file, resample_spectra
+from pipeline.notebook       import Spectrum, SpectraCollection, build_config
 from pipeline.processor      import (
     SVCDataProcessor,      # chainable load/group/average
     SigSpectraAverager,    # facade — pass a DataFrame, get aggregated DataFrame back
@@ -221,18 +237,21 @@ Detailed signatures and behavioural notes in [`pipeline/README.md`](pipeline/REA
 
 ## Demo Notebook
 
-The demo notebook uses an external 15-file `.sig` artifact because raw headers
-contain GPS/location metadata. Prepare local demo data with:
-
-```bash
-python3 scripts/prepare_demo_data.py \
-  --source-dir data/a4any_sb_2025-cn_ch-svc-aviris_bottom
-```
-
-The notebook is config-driven: edit the settings cell (`DATA_FOLDER`,
-`OUTPUT_FOLDER`, `INSTRUMENT`) to run it on your own data and instrument. See
+[`notebooks/pipeline_demo.ipynb`](notebooks/pipeline_demo.ipynb) is designed to
+be shared as a standalone file: its first code cell checks for the notebook
+helpers, installs `svc-processing[demo]>=0.1.5` into the current kernel when
+needed, and falls back to the public GitHub source archive while that release is
+not yet on PyPI. The tutorial assumes you have an authorized folder of raw
+`.sig` scans; set `DATA_FOLDER`, `OUTPUT_FOLDER`, `INSTRUMENT`, and `END_LINE` in
+the opening cells. Raw field scans are not shipped in the public repository
+because their headers can contain time and GPS metadata.
+See
 [`notebooks/pipeline_demo/README.md`](notebooks/pipeline_demo/README.md).
 
+Authorized parity work can still stage the separate external field dataset with
+[`scripts/prepare_demo_data.py`](scripts/prepare_demo_data.py); those raw files
+never enter the package or default notebook path.
+
 ---
 
 ## Requirements
@@ -241,7 +260,7 @@ Python 3.11 is the supported runtime. Runtime, demo, and development
 dependencies are declared in [`pyproject.toml`](pyproject.toml).
 
 - `numpy`, `scipy`, `pandas` — numerical core.
-- `matplotlib` — demo notebook plotting.
+- `matplotlib`, `ipykernel` — demo notebook plotting and execution.
 - `pytest>=8.3.0` — test runner for local verification.
 
 Install with `python -m pip install -e ".[dev,demo]"` for local development and

{svc_processing-0.1.3 → svc_processing-0.1.5}/README.md

@@ -44,14 +44,28 @@ svc-pipeline --init-config   # command name — different from the package name
 svc-pipeline
 ```
 
-**Working from a clone of this repo** (config/config.json already exists):
+**Working from a clone of this repo** (config/config.json already exists) — run the
+setup script once, then activate the environment it created:
+
+```bash
+./setup.sh            # creates .venv and installs the project + notebook tools
+# ./setup.sh --dev    # add the test & lint tools for development
+
+source .venv/bin/activate          # macOS / Linux
+# .venv\Scripts\activate           # Windows PowerShell
+
+# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
+svc-pipeline config.json
+```
+
+The script always installs into *this* repo's `.venv` no matter which folder you run
+it from, so it avoids the "Directory '.' is not installable" and "No module named …"
+errors that come from being in the wrong directory. Prefer to do it by hand?
 
 ```bash
 python3.11 -m venv .venv
 source .venv/bin/activate
 python -m pip install -e ".[dev,demo]"
-
-# Edit config/config.json — replace "<PATH_TO_SIG_INPUT_ROOT>" with your data path.
 svc-pipeline config.json
 ```
 
@@ -164,6 +178,7 @@ The most-used entry points (all importable from their concrete modules — `pipe
 ```python
 from pipeline.sig_processor import SigFileProcessor   # truncation + instrument inspection
 from pipeline.resampler      import process_sig_file, resample_spectra
+from pipeline.notebook       import Spectrum, SpectraCollection, build_config
 from pipeline.processor      import (
     SVCDataProcessor,      # chainable load/group/average
     SigSpectraAverager,    # facade — pass a DataFrame, get aggregated DataFrame back
@@ -188,18 +203,21 @@ Detailed signatures and behavioural notes in [`pipeline/README.md`](pipeline/REA
 
 ## Demo Notebook
 
-The demo notebook uses an external 15-file `.sig` artifact because raw headers
-contain GPS/location metadata. Prepare local demo data with:
-
-```bash
-python3 scripts/prepare_demo_data.py \
-  --source-dir data/a4any_sb_2025-cn_ch-svc-aviris_bottom
-```
-
-The notebook is config-driven: edit the settings cell (`DATA_FOLDER`,
-`OUTPUT_FOLDER`, `INSTRUMENT`) to run it on your own data and instrument. See
+[`notebooks/pipeline_demo.ipynb`](notebooks/pipeline_demo.ipynb) is designed to
+be shared as a standalone file: its first code cell checks for the notebook
+helpers, installs `svc-processing[demo]>=0.1.5` into the current kernel when
+needed, and falls back to the public GitHub source archive while that release is
+not yet on PyPI. The tutorial assumes you have an authorized folder of raw
+`.sig` scans; set `DATA_FOLDER`, `OUTPUT_FOLDER`, `INSTRUMENT`, and `END_LINE` in
+the opening cells. Raw field scans are not shipped in the public repository
+because their headers can contain time and GPS metadata.
+See
 [`notebooks/pipeline_demo/README.md`](notebooks/pipeline_demo/README.md).
 
+Authorized parity work can still stage the separate external field dataset with
+[`scripts/prepare_demo_data.py`](scripts/prepare_demo_data.py); those raw files
+never enter the package or default notebook path.
+
 ---
 
 ## Requirements
@@ -208,7 +226,7 @@ Python 3.11 is the supported runtime. Runtime, demo, and development
 dependencies are declared in [`pyproject.toml`](pyproject.toml).
 
 - `numpy`, `scipy`, `pandas` — numerical core.
-- `matplotlib` — demo notebook plotting.
+- `matplotlib`, `ipykernel` — demo notebook plotting and execution.
 - `pytest>=8.3.0` — test runner for local verification.
 
 Install with `python -m pip install -e ".[dev,demo]"` for local development and