Mercurial > repos > pointsource_algs / file comparison
comparison: README.md
README.md
- branch
- dev
- changeset 35
- b087e3eab191
- parent 17
- de8d43ebfd0d
- child 40
- 896b42b5ac1a
equal
deleted
inserted
replaced
| 34:efa60bc4f743 | 35:b087e3eab191 |
|---|---|
| 50 [Homebrew]: https://brew.sh | 50 [Homebrew]: https://brew.sh |
| 51 [arXiv:2212.02991]: https://arxiv.org/abs/2212.02991 | 51 [arXiv:2212.02991]: https://arxiv.org/abs/2212.02991 |
| 52 | 52 |
| 53 ### Building and running the experiments | 53 ### Building and running the experiments |
| 54 | 54 |
| 55 To compile the code and run the experiments in the manuscript, use | 55 To compile and install the program, use |
| 56 ```console | |
| 57 cargo install --path=. | |
| 58 ``` | |
| 59 When doing this for the first time, several dependencies will be downloaded. | |
| 60 Now you can run the default experiment with | |
| 61 ``` | |
| 62 pointsource_algs -o results | |
| 63 ``` | |
| 64 The `-o results` option tells `pointsource_algs` to write results in the | |
| 65 `results` directory. The option is required. | |
| 66 | |
| 67 Alternatively, you may build and run the program without installing with | |
| 56 ```console | 68 ```console |
| 57 cargo run --release -- -o results | 69 cargo run --release -- -o results |
| 58 ``` | 70 ``` |
| 59 When doing this for the first time, several dependencies will be downloaded. | 71 The double-dash separates the options for the Cargo build system |
| 60 The double-dash (`--`) separates the arguments of Cargo and this software, | 72 and `pointsource_algs`. |
| 61 `pointsource_algs`. The `--release` option to Cargo is required for `rustc` to | |
| 62 build optimised high performance code. Without that flag the performance will | |
| 63 be significantly worse. The `-o results` option tells `pointsource_algs` to | |
| 64 write results in the `results` directory. The option is required. | |
| 65 | |
| 66 Alternatively, you may build the executable with | |
| 67 ```console | |
| 68 cargo build --release | |
| 69 ``` | |
| 70 and then run it with | |
| 71 ``` | |
| 72 target/release/pointsource_algs -o results | |
| 73 ``` | |
| 74 | 73 |
| 75 ### Documentation | 74 ### Documentation |
| 76 | 75 |
| 77 Use the `--help` option to get an extensive listing of command line options to | 76 Use the `--help` option to get an extensive listing of command line options to |
| 78 customise algorithm parameters and the experiments performed. As above with | 77 customise algorithm parameters and the experiments performed. |
| 79 `-o`, if using `cargo` to run the executable, you have to pass any arguments | |
| 80 to `pointsource_algs` after a double-dash: | |
| 81 ```console | |
| 82 cargo run --release -- --help | |
| 83 ``` | |
| 84 | 78 |
| 85 ## Internals | 79 ## Internals |
| 86 | 80 |
| 87 If you are interested in the program internals, the integrated source code | 81 If you are interested in the program internals, the integrated source code |
| 88 documentation may be built and opened with | 82 documentation may be built and opened with |
