Mercurial > repos > public > sbplib_julia

comparison README.md @ 1171:87bc91def1ff tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Start setting things up
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 24 Jan 2023 21:57:24 +0100
parents 0862bed6e6b4
children 12b525cd3da6
comparison
equal deleted inserted replaced
1170:6f14a88be123 1171:87bc91def1ff
26 ``` 26 ```
27 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"]) 27 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"])
28 ``` 28 ```
29 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder. 29 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder.
30 30
31 ## Running benchmarks
32 Benchmarks are defined in `benchmark/` use the tools for benchmark suites in BenchmarkTools.jl
33 The format is compatible with PkgBenchmark.jl which helps with running the suite, comparing results and presenting the results in a readable way.
34
35 `benchmark/` contains a julia environment with the necessary packages for working with the benchmarks.
36
37 `activate benchmark`
38
39 ```julia
40 using PkgBenchmark
41 import Sbplib
42 r = benchmarkpkg(Sbplib)
43
44 export_markdown(stdout, r)
45 ```
46
47 #TODO: Clean this up
48
31 49
32 ## Generating and using the documentation 50 ## Generating and using the documentation
33 Generating the documentation can be done using either `make` or through activating the `docs` environment and including the script `docs/make.jl` at the REPL. 51 Generating the documentation can be done using either `make` or through activating the `docs` environment and including the script `docs/make.jl` at the REPL.
34 52
35 Using `make` there are three targets 53 Using `make` there are three targets