tacman1123 commited on
Commit
a825d04
·
1 Parent(s): f42ed4f
Files changed (1) hide show
  1. README.md +39 -0
README.md ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Digital Commonwealth Collection Archive
2
+
3
+ This dataset is a bulk archive of collection-level JSONL exports derived from Digital Commonwealth record listings.
4
+
5
+ Why this exists:
6
+ - Digital Commonwealth exposes rich record data, but not as a simple bulk-download page for all collections.
7
+ - Repeatedly harvesting the public listing or API for every downstream use creates unnecessary load and requires thousands of requests.
8
+ - This archive provides stable, reusable collection files so Museado and others can work from a local or mirrored copy instead of rebuilding the corpus each time.
9
+
10
+ Contents:
11
+ - `*.jsonl.gz`: one gzip-compressed JSONL file per collection
12
+ - `datasets.jsonl`: collection manifest with dataset keys, labels, archive filenames, counts, and source links
13
+ - `institutions.jsonl`: institution-level summary manifest
14
+
15
+ Upstream:
16
+ - Main site: https://www.digitalcommonwealth.org/
17
+ - API / developer information: https://www.digitalcommonwealth.org/developers
18
+ - OAI-PMH endpoint and collection metadata are also used during the collection mapping process
19
+
20
+ Methodology:
21
+ 1. Harvest provider-wide listing pages from Digital Commonwealth.
22
+ 2. Parse each page into JSONL shards.
23
+ 3. Split records by collection code.
24
+ 4. Write one compressed JSONL archive per collection.
25
+ 5. Emit `datasets.jsonl` and `institutions.jsonl` so downstream systems can bootstrap local datasets without refetching the global listing.
26
+
27
+ Typical downstream use:
28
+ - mirror this archive
29
+ - materialize local dataset directories
30
+ - symlink each collection archive into `05_raw/obj.jsonl.gz`
31
+ - normalize and index from the local raw symlink
32
+
33
+ Maintainer note:
34
+ To refresh this archive from a fast connection, run:
35
+
36
+ ```bash
37
+ bin/console dc:global:fetch
38
+ bin/console dc:global:archive
39
+ ```