nps-cli 0.1.0__tar.gz → 0.1.1__tar.gz

{nps_cli-0.1.0 → nps_cli-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nps-cli
-Version: 0.1.0
+Version: 0.1.1
 Summary: A simple CLI for sampling point clouds from large volumetric datasets
 Author: Jakob Troidl
 License-Expression: MIT
@@ -20,13 +20,12 @@ Requires-Dist: ruff; extra == "dev"
 # CLI for Point Cloud Sampling
 
 ```
-pip install nps
+pip install nps-cli
 ````
 ### Get started
 
-
 ```zsh
-(nps-v2) ➜  nps git:(main) ✗ nps --help
+nps --help
 Usage: nps [OPTIONS]
 
 Options:
@@ -52,6 +51,32 @@ Options:
   -h, --help                      Show this message and exit.
 ```
 
+### Example usage
+
 ```bash
 nps --cv-path precomputed://gs://neuroglancer-janelia-flyem-hemibrain/v1.0/segmentation
 ```
+
+### Reading Point Clouds
+
+Please refer to the [pocaduck](https://github.com/JaneliaSciComp/pocaduck?tab=readme-ov-file#querying-point-clouds) repo on how to read point clouds from the output directory:
+
+```python
+from pocaduck import Query
+
+# Create a query object
+query = Query(storage_config=<PATH>) # path to folder where nps output is stored
+
+# Get all available labels
+labels = query.get_labels()
+print(f"Available labels: {labels}")
+
+# Get all points for a label (aggregated across all blocks)
+points = query.get_points(label=12345)
+print(f"Retrieved {points.shape[0]} points for label 12345")
+
+# Close the query connection when done
+query.close()
+```
+
+For optimized point cloud reading, consider [this](https://github.com/JaneliaSciComp/pocaduck?tab=readme-ov-file#running-the-optimization-pipeline).

{nps_cli-0.1.0 → nps_cli-0.1.1}/README.md

@@ -1,13 +1,12 @@
 # CLI for Point Cloud Sampling
 
 ```
-pip install nps
+pip install nps-cli
 ````
 ### Get started
 
-
 ```zsh
-(nps-v2) ➜  nps git:(main) ✗ nps --help
+nps --help
 Usage: nps [OPTIONS]
 
 Options:
@@ -33,6 +32,32 @@ Options:
   -h, --help                      Show this message and exit.
 ```
 
+### Example usage
+
 ```bash
 nps --cv-path precomputed://gs://neuroglancer-janelia-flyem-hemibrain/v1.0/segmentation
-```
+```
+
+### Reading Point Clouds
+
+Please refer to the [pocaduck](https://github.com/JaneliaSciComp/pocaduck?tab=readme-ov-file#querying-point-clouds) repo on how to read point clouds from the output directory:
+
+```python
+from pocaduck import Query
+
+# Create a query object
+query = Query(storage_config=<PATH>) # path to folder where nps output is stored
+
+# Get all available labels
+labels = query.get_labels()
+print(f"Available labels: {labels}")
+
+# Get all points for a label (aggregated across all blocks)
+points = query.get_points(label=12345)
+print(f"Retrieved {points.shape[0]} points for label 12345")
+
+# Close the query connection when done
+query.close()
+```
+
+For optimized point cloud reading, consider [this](https://github.com/JaneliaSciComp/pocaduck?tab=readme-ov-file#running-the-optimization-pipeline).

{nps_cli-0.1.0 → nps_cli-0.1.1}/nps/main.py

@@ -34,8 +34,9 @@ def main(cv_path, mip, timestamp, output_dir, num_workers, cpus_per_worker, queu
         click.echo("Sampling points only (no SVIDs)...")
         svids = None
 
-    if not os.path.exists(output_dir):
-        os.makedirs(output_dir)
+    points_dir = os.path.join(output_dir, 'points')
+    if not os.path.exists(points_dir):
+        os.makedirs(points_dir)
 
     if worker_type == 'LocalWorker':
         click.echo("Using LocalWorker for sampling.")
@@ -52,7 +53,7 @@ def main(cv_path, mip, timestamp, output_dir, num_workers, cpus_per_worker, queu
         svids=svids,
         block_size=np.array(block_size),
         num_workers=num_workers,
-        out_dir=output_dir,
+        out_dir=points_dir,
         fraction=fraction,
         worker_config=worker_config
     )

{nps_cli-0.1.0 → nps_cli-0.1.1}/nps_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nps-cli
-Version: 0.1.0
+Version: 0.1.1
 Summary: A simple CLI for sampling point clouds from large volumetric datasets
 Author: Jakob Troidl
 License-Expression: MIT
@@ -20,13 +20,12 @@ Requires-Dist: ruff; extra == "dev"
 # CLI for Point Cloud Sampling
 
 ```
-pip install nps
+pip install nps-cli
 ````
 ### Get started
 
-
 ```zsh
-(nps-v2) ➜  nps git:(main) ✗ nps --help
+nps --help
 Usage: nps [OPTIONS]
 
 Options:
@@ -52,6 +51,32 @@ Options:
   -h, --help                      Show this message and exit.
 ```
 
+### Example usage
+
 ```bash
 nps --cv-path precomputed://gs://neuroglancer-janelia-flyem-hemibrain/v1.0/segmentation
 ```
+
+### Reading Point Clouds
+
+Please refer to the [pocaduck](https://github.com/JaneliaSciComp/pocaduck?tab=readme-ov-file#querying-point-clouds) repo on how to read point clouds from the output directory:
+
+```python
+from pocaduck import Query
+
+# Create a query object
+query = Query(storage_config=<PATH>) # path to folder where nps output is stored
+
+# Get all available labels
+labels = query.get_labels()
+print(f"Available labels: {labels}")
+
+# Get all points for a label (aggregated across all blocks)
+points = query.get_points(label=12345)
+print(f"Retrieved {points.shape[0]} points for label 12345")
+
+# Close the query connection when done
+query.close()
+```
+
+For optimized point cloud reading, consider [this](https://github.com/JaneliaSciComp/pocaduck?tab=readme-ov-file#running-the-optimization-pipeline).

{nps_cli-0.1.0 → nps_cli-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nps-cli"
-version = "0.1.0"
+version = "0.1.1"
 description = "A simple CLI for sampling point clouds from large volumetric datasets"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"