diff --git a/README.md b/README.md index 8766e9fbde6ea813832892fce23c750463ef07ab..b535f8fc72d20bc19dd7187a855de7dfe12d263f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ contact: francesco.tomba@phd.units.it -# USAGE +# Usage Clone the repository and compile with `make` The compilation process produces an executable called `main`, run it with `mpirun` The suggestion is to run it with one mpi task per socket. @@ -13,7 +13,7 @@ The suggestion is to run it with one mpi task per socket. - -o --out-data *(optional)* output path for the data, the datafile is shuffled between mpi tasks and datapoints are ordered default is `out_data` - -a --out-assignment *(optional)* output path for the cluster assignment output ranges [0 ... Nc - 1] for core points halo points have indices [-Nc ... -1] conversion of idx for an halo point is `cluster_idx = -halo_idx - 1`, default is `out_assignment` -# TODO +# Todo - [x] ~~arugment parser~~ - [ ] prettify overall stdout