Mercurial > repos > pointsource_algs / file comparison
comparison: README.md
README.md
- branch
- dev
- changeset 61
- 4f468d35fa29
- parent 57
- 5c9c5649c35d
equal
deleted
inserted
replaced
| 60:9738b51d90d7 | 61:4f468d35fa29 |
|---|---|
| 34 this can be done with | 34 this can be done with |
| 35 ```console | 35 ```console |
| 36 brew install gsl | 36 brew install gsl |
| 37 ``` | 37 ``` |
| 38 For other operating systems, suggestions are available in the [rust-GSL] | 38 For other operating systems, suggestions are available in the [rust-GSL] |
| 39 crate documentation. You may need to pass extra `RUSTFLAGS` options to | 39 crate documentation. If not correctly installed, you may need to pass |
| 40 Cargo in the following steps to locate the library. | 40 extra `RUSTFLAGS` options to Cargo in the following steps to locate the |
| 41 library. | |
| 41 | 42 |
| 42 4. Download [alg_tools] and unpack it under the same directory as this | 43 4. Download [alg_tools] and unpack it under the same directory as this |
| 43 package. | 44 package. |
| 44 | 45 |
| 45 [rustup]: https://rustup.rs | 46 [rustup]: https://rustup.rs |
| 59 cargo install --path=. | 60 cargo install --path=. |
| 60 ``` | 61 ``` |
| 61 When doing this for the first time, several dependencies will be downloaded. | 62 When doing this for the first time, several dependencies will be downloaded. |
| 62 Now you can run the default set of experiments with | 63 Now you can run the default set of experiments with |
| 63 ``` | 64 ``` |
| 64 pointsource_algs -o results | 65 pointsource_experiments -o results |
| 65 ``` | 66 ``` |
| 66 The `-o results` option tells `pointsource_algs` to write results in the | 67 The `-o results` option tells `pointsource_algs` to write results in the |
| 67 `results` directory. The option is required. | 68 `results` directory. The option is required. |
| 68 | 69 |
| 69 Alternatively, you may build and run the program without installing with | 70 Alternatively, you may build and run the program without installing with |
| 70 ```console | 71 ```console |
| 71 cargo run --release -- -o results | 72 cargo run --release -- -o results |
| 72 ``` | 73 ``` |
| 73 The double-dash separates the options for the Cargo build system | 74 The double-dash separates the options for the Cargo build system |
| 74 and `pointsource_algs`. | 75 and `pointsource_experiments`. |
| 75 | 76 |
| 76 ### Documentation | 77 ### Documentation |
| 77 | 78 |
| 78 Use the `--help` option to get an extensive listing of command line options to | 79 Use the `--help` option to get an extensive listing of command line options to |
| 79 customise algorithm parameters and the experiments performed. | 80 customise algorithm parameters and the experiments performed. |
