Skip to content

Commit

Permalink
We should always fail on a hash mismatch. This was an early debugging…
Browse files Browse the repository at this point in the history
… step that can be dropped.
  • Loading branch information
richardreeve committed Jun 24, 2021
1 parent 05f71c4 commit 34b586f
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 7 deletions.
3 changes: 0 additions & 3 deletions content/docs/API/python/file_api.md
Expand Up @@ -21,7 +21,6 @@ The config file lets users specify metadata to be used during file lookup, and c
```
data_directory: .
access_log: access-{run_id}.yaml
fail_on_hash_mismatch: True
run_metadata:
description: A test model
data_registry_url: https://data.scrc.uk/api/
Expand Down Expand Up @@ -54,8 +53,6 @@ write:

`access_log` specifies the filename used to record the access log (default “access-{run_id}.yaml”). It may be relative; in which case it is relative to the directory containing the config file. It may contain the string `{run_id}`, which will be replaced with the run id. It may be set to the boolean value False to indicate that no access log should be written.

`fail_on_hash_mismatch` will, if set to True (the default), cause the API to fail is an attempt is made to read a file whose computed hash differs from the one stored in the `metadata.yaml` file.

`run_id` specifies the run id to be used, otherwise a hash of the config contents and the date will be used.

`run_metadata` provides metadata for the run that will be passed through to the access log.
Expand Down
4 changes: 0 additions & 4 deletions content/docs/interface/config/_index.md
Expand Up @@ -16,7 +16,6 @@ This page gives examples of the **user written** *config.yaml* file.
The following example reads various pieces of data and writes an external object.

```yaml
fail_on_hash_mismatch: True
run_metadata:
description: A simple analysis
local_data_registry_url: https://localhost:8000/api/
Expand Down Expand Up @@ -57,8 +56,6 @@ write:
version: {MINOR}
```

- `fail_on_hash_mismatch:` will, if set to True (the default), cause the API to fail is an attempt is made to read a file whose computed hash differs from the one stored in the local registry

- `run_metadata:` provides metadata for the run:
- `description:` is a human readable description of the purpose of the config.yaml
- `local_data_registry_url:` specifies the local data registry root, which defaults to https<!-- -->://localhost:8000/api/
Expand Down Expand Up @@ -154,7 +151,6 @@ write:
The following example describes an analysis which typically reads *human/population* and writes *human/outbreak-timeseries*. Instead, a test model is run using Scottish data, whereby *scotland/human/population* is read from the *eera* namespace, rather than *human/population*. Likewise, the output is written as *scotland/human/outbreak-timeseries* rather than *human/outbreak-timeseries*.

```yaml
fail_on_hash_mismatch: True
run_metadata:
description: A test model
local_data_registry_url: https://localhost:8000/api/
Expand Down

0 comments on commit 34b586f

Please sign in to comment.