Handle tests with NIST data as integration tests

.gitignore

@@ -7,6 +7,9 @@
 # Executables
 *.exe
 
+# Test data for integration tests
+tests/*.dat
+
 # Generated by Cargo
 /target/
 *.lock

Cargo.toml

@@ -11,7 +11,7 @@ homepage = "https://github.com/statrs-dev/statrs"
 repository = "https://github.com/statrs-dev/statrs"
 edition = "2018"
 
-include = ["CHANGELOG.md", "LICENSE.md", "src/"]
+include = ["CHANGELOG.md", "LICENSE.md", "src/", "tests/"]
 
 [lib]
 name = "statrs"
@@ -25,3 +25,4 @@ num-traits = "0.2.14"
 
 [dev-dependencies]
 criterion = "0.3.3"
+anyhow = "1.0"

README.md

@@ -35,6 +35,19 @@ statrs = "*" # replace * by the latest version of the crate.
 
 For examples, view [the docs](https://docs.rs/statrs/*/statrs/).
 
+### Running tests
+
+If you'd like to run all suggested tests, you'll need to download some data from
+NIST, we have a script for this and formatting the data in the `tests/` folder.
+
+```sh
+cargo test
+./tests/gather_nist_data.sh && cargo test -- --include-ignored nist_
+```
+
+If you'd like to modify where the data is downloaded, you can use the environment variable,
+`STATRS_NIST_DATA_DIR` for running the script and the tests.
+
 ## Contributing
 
 Thanks for your help to improve the project!