Clarify source data setup requirements
This commit is contained in:
@@ -5,6 +5,11 @@ redistribute licensed, restricted, or third-party raw source files. Raw files
|
||||
needed to regenerate processed inputs should be kept in `_local/raw/` or another
|
||||
local-only directory selected with `PARTY2D_RAW_DATA_DIR`.
|
||||
|
||||
The source setup scripts are provided specifically to avoid redistributing those
|
||||
source files while still documenting how to obtain and test them locally. Users
|
||||
must use their own Manifesto Project API key and must obtain the Morgan OCR/
|
||||
transcription file separately.
|
||||
|
||||
The data setup workflow writes intermediates to `_local/build/`, regenerated
|
||||
inputs to `_local/generated-inputs/`, and comparison reports to `_local/reports/`.
|
||||
It does not overwrite committed `data/` files.
|
||||
@@ -108,5 +113,6 @@ The Manifesto Project main dataset requires a Manifesto API key/login. Set
|
||||
`MANIFESTO_API_KEY` or `PARTY2D_MANIFESTO_API_KEY` for scripted download.
|
||||
|
||||
The Morgan historical file is a local OCR/transcription source from Morgan
|
||||
(1976), not a public provider download. It must be placed locally at
|
||||
`$PARTY2D_RAW_DATA_DIR/morgan/morgan_positions_raw.csv` for full rebuild tests.
|
||||
(1976), not a public provider download. It can be provided on request and must be
|
||||
placed locally at `$PARTY2D_RAW_DATA_DIR/morgan/morgan_positions_raw.csv` for
|
||||
full rebuild tests.
|
||||
|
||||
Reference in New Issue
Block a user