Skip to content

Commit 225a0e2

Browse files
committed
feature: Add large files recommended for benchmarking by Brenton
I've added these files to this repository, as Git LFS entries. fixup: Clarify comment in .gitattributes
1 parent 0871f24 commit 225a0e2

File tree

6 files changed

+39
-0
lines changed

6 files changed

+39
-0
lines changed

.lfsconfig

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[lfs]
2+
# Ensure that a default checkout of this repository doesn't download any
3+
# large files.
4+
fetchexclude = *

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,27 @@ Out[2]= $Failed
102102
This means that CodeParser was built with a newer version of Wolfram System than your system supports.
103103

104104
To fix this, build CodeParser from source with the version of Wolfram System that you will use.
105+
106+
## Benchmarks
107+
108+
> Some of the benchmarks test large data files. Those files are tracked in this
109+
> repository to ensure that benchmarks are always run against identical input.
110+
> [Git LFS](https://git-lfs.github.com/) is used to ensure that a basic checkout
111+
> of this repository remains small, which is important in CI/CD builds.
112+
113+
To run the benchmarks, first ensure that the large benchmark files have been
114+
checked out locally using:
115+
116+
```shell
117+
$ git lfs pull --exclude="" --include="*"
118+
```
119+
120+
This will override the default settings in [`.lfsconfig`](./.lfsconfig).
121+
122+
## File Overview
123+
124+
* [Tests/files/large/](./Tests/files/large/) contains files
125+
managed by [`Git LFS`](https://git-lfs.github.com/). The files in this
126+
directory are used by the benchmarks. These files should never be modified, to
127+
ensure that benchmark comparisions between different revisions of this
128+
repository can be meaningfully compared.

Tests/files/.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Use Git LFS to store all of the files in the files/large/ directory
2+
large/* filter=lfs diff=lfs merge=lfs -text

Tests/files/large/ReliefPlot.nb

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:08dbac51a17a741b997bd7c60d13ea0fe7d6c970191aa2c07356f2c26d70b1b1
3+
size 244135221
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:c32e17edc64ee9b94e6c7a36c9dd7e837a1be0d965c51098ae41edd428874af8
3+
size 71487044

Tests/files/large/geomagneticmodels.m

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:682f7198f2468d2ebfa23eacb971dce688cc3229873feb4960f704bf823eec92
3+
size 6827153

0 commit comments

Comments
 (0)