Metadata-Version: 2.4
Name: bolero-denmark
Version: 0.1.0.post6
Summary: Danish literature and register-schema resources for Bolero, unpacked by `bolero-harness denmark`
Author: Northwestern-CSSI
License-Expression: MIT AND LicenseRef-Corpus-Rights
Project-URL: Homepage, https://github.com/Northwestern-CSSI/Bolero-denmark
Keywords: bolero,denmark,statistics-denmark,register-data,corpus
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE.md
Dynamic: license-file

# bolero-denmark

The canonical Danish literature and schema resource root for Bolero. The GitHub
repository preserves curated agent context plus legally redistributable source
snapshots; the data-only PyPI distribution carries the curated text, catalogs,
and templates while `.gitattributes` excludes bulk `originals/` from the wheel.

## Use

```bash
pip install bolero-ai bolero-denmark
bolero-harness denmark            # unpack this repository's runtime resources
bolero-harness denmark DIR --force
```

`bolero-harness denmark` (bolero-ai >= 0.1.8.post3) uses the same hardened tar
extraction as the harness source tree. Without bolero-ai:

```python
python3 -c "import bolero_denmark, tarfile; tarfile.open(bolero_denmark.archive_path()).extractall('.', filter='data')"
```

The package archive is produced with `git archive HEAD`. Paths marked
`export-ignore` are therefore available in GitHub clones but not the PyPI
payload. The `DST_agentic_ext/` submodule is also not embedded. To populate it
in a checkout with upstream access:

```bash
git clone --recurse-submodules https://github.com/Northwestern-CSSI/Bolero-denmark.git
# or: git submodule update --init
```

## What is inside

```text
resources/
  literature/             economics and medical disciplinary norms, catalogs,
                          reusable templates, target-paper source material,
                          9 paper Markdown conversions, and the systematic
                          Danish-register economics extraction corpus
  schema/                 agent-facing FSV/TIMES and lean HKV documentation,
                          normalized pilot inventory, approved-upload-list evidence,
                          official DST/SDS documents, SKS/LPR material, and
                          pinned parsed Danish/English/mapping source archives
replication/              registered replication decks for Jensen–Zhang,
                          Eriksen–Munk, and Mikkelsen et al.
preregistration/          frozen study protocols and transcribed decks whose
                          required registers are tracked separately from runtime availability
DST_agentic_ext/          pinned private collaboration submodule; pointer only
```

Start with [`resources/README.md`](resources/README.md). The Chinese
classification and synthesis is
[`resources/RESOURCE_CLASSIFICATION.zh.md`](resources/RESOURCE_CLASSIFICATION.zh.md).

The schema scale currently represented by the curated layer is 531 FSV
registers (29,234 variables), 121 TIMES top-level registers (9,843 documented
variable occurrences), and a lean HKV index covering 71 datasets and 881
variables. The literature layer includes 828 systematic economics
corpus rows, 229 confirmed papers, structured extraction/audit records, eight
target/pilot papers in nine Markdown versions, and economics and medical
standards with source-level rights/provenance decisions.

## Source preservation versus runtime payload

- Exact public or licensed originals are retained under `resources/**/originals/`
  and bound by SHA-256. The Mikkelsen target originals live in
  `resources/literature/medical/target/`. These files remain in GitHub but are
  excluded from `git archive` so the runtime wheel stays focused and does not
  duplicate large provenance archives.
- Copyrighted sources without confirmed redistribution rights are represented
  by canonical citation, URL, rights status, and an original project summary;
  their PDFs are not copied.
- The expanded raw registry metadata layer (~876 MB) is preserved through the
  archived parsed Danish, unofficial-English, FSV, and mapping releases. The
  included generators deterministically rebuild the curated FSV, TIMES, and
  lean HKV views from a documented assembled source layout; the upstream crawl
  itself is not duplicated here.
- No row-level registry microdata is present. Public names, register codes,
  variable descriptions, and documentation URLs are schema, not observations.
- Private Slack/email transcripts and operational credentials are not packaged.
  Scientific conclusions derived from project coordination are rewritten as
  public, auditable summaries.

## Resource semantics

`literature/` answers “what makes this analysis scientifically defensible?”
`schema/` answers “what does this data source mean, and what evidence supports
its availability?” A pilot-sheet listing, public codebook, grant approval,
runtime mount, and validated table are distinct evidence states. See
[`resources/schema/README.md`](resources/schema/README.md).

Replication decks cite resources relative to the mounted `resources/` root:
for example `literature/papers/md/...` and
`schema/data-registry-bolero/fsv/...`. Their registered scientific protocol is
fixed; only equivalent data operationalization may adapt silently.

## Licensing and provenance

The project license expression is `MIT AND LicenseRef-Corpus-Rights`. MIT covers
the packaging and project-authored material. `NOTICE.md` identifies the rights
of every corpus class. Each discipline catalog records source URLs, licenses,
and whether an exact file was archived or kept link-only. Checksums are in:

- `resources/literature/CHECKSUMS.sha256`
- `resources/schema/provenance/CHECKSUMS.sha256`

Official Danish source content is authoritative relative to the English
translation. Parsed snapshots can be stale or erroneous; English schema text
is explicitly an unofficial machine translation for retrieval.

## Release

`.github/workflows/release.yml` builds from a tag, publishes the GitHub Release,
and publishes the same files to PyPI through Trusted Publishing. The tag must
equal `v` + the version in `pyproject.toml`.

```bash
# bump version in pyproject.toml, commit, then:
git tag v0.1.0.post5 && git push origin main v0.1.0.post5
```

`packaging/build-release.sh` performs the same local build. No release is made
merely by updating `main`.
