Skip to content

Commit 332af23

Browse files
Document vieclus_ prefix for brew-installed helper tools
1 parent 56b5dec commit 332af23

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,22 +90,26 @@ mpirun -n P vieclus <graph-file> [options]
9090

9191
**Included tools:**
9292

93-
| Program | Description |
94-
|:--------|:-----------|
95-
| `vieclus` | Main clustering algorithm |
96-
| `graphchecker` | Validate that a graph file is correctly formatted |
97-
| `evaluator` | Compute modularity of a given clustering: `./deploy/evaluator <graph> --input_partition=<clustering>` |
93+
| Program | Homebrew name | Description |
94+
|:--------|:-------------|:-----------|
95+
| `vieclus` | `vieclus` | Main clustering algorithm |
96+
| `graphchecker` | `vieclus_graphchecker` | Validate that a graph file is correctly formatted |
97+
| `evaluator` | `vieclus_evaluator` | Compute modularity of a given clustering |
98+
99+
> **Note:** When installed via Homebrew, `graphchecker` and `evaluator` are prefixed with `vieclus_` to avoid name collisions with other tools (e.g. KaHIP). When built from source, the original names are used in `./deploy/`.
98100
99101
**Example workflow:**
100102
```bash
101103
# 1. Check your graph file
102-
./deploy/graphchecker mygraph.graph
104+
./deploy/graphchecker mygraph.graph # from source
105+
vieclus_graphchecker mygraph.graph # via brew
103106

104107
# 2. Cluster it (4 MPI processes, 60 second time limit)
105108
mpirun -n 4 ./deploy/vieclus mygraph.graph --time_limit=60 --output_filename=result.clustering
106109

107110
# 3. Evaluate the result
108-
./deploy/evaluator mygraph.graph --input_partition=result.clustering
111+
./deploy/evaluator mygraph.graph --input_partition=result.clustering # from source
112+
vieclus_evaluator mygraph.graph --input_partition=result.clustering # via brew
109113
```
110114

111115
---

0 commit comments

Comments
 (0)