Datasets:

Languages:
English
License:
hatapakacha7 commited on
Commit
a5264b8
·
verified ·
1 Parent(s): ad2bba0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -6
README.md CHANGED
@@ -12,7 +12,6 @@ tags:
12
  - NA
13
  ---
14
 
15
-
16
  # Thal-Kak local MSA, template databases
17
 
18
  The sequence and template databases that the local MSA modes of
@@ -28,7 +27,7 @@ local template search on any of them.
28
  > **These are derived databases, not upstream mirrors.** Each archive was
29
  > re-clustered and/or reformatted here. Numbers computed on them will not match
30
  > numbers computed on the upstream distribution. What was changed is recorded
31
- > per source in [`LICENSE`](LICENSE), under `Changes`.
32
 
33
  ## At a glance
34
 
@@ -144,9 +143,14 @@ running the installer — it reads that file and never writes it.
144
  pip install -U "huggingface_hub[cli]"
145
 
146
  hf download cssbsnu/Thal-Kak_local_db --repo-type dataset \
147
- --include "hhblits/envhog.tar.zst" --local-dir ./dl
148
  ```
149
 
 
 
 
 
 
150
  Unpacking by hand is possible (`zstd -dc <archive> | tar -x -C <dir>`) but you
151
  then have to reproduce the layout yourself: each database lives at
152
  `<family root>/<key>/`, with every file inside renamed from its build-time stem
@@ -169,13 +173,34 @@ overhead to a single archive.
169
  Everything, all four families: **5.41 TiB** installed, ~5.7 TiB peak when
170
  installed family by family.
171
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
172
  ## License and attribution
173
 
174
  **The Apache-2.0 license on the Thal-Kak source code does not apply to anything
175
  in this repository.** Each archive carries the license of the source it derives
176
  from; no archive mixes sources. The authoritative record — upstream license,
177
  the license we place on our archive, attribution, citation, and exactly what we
178
- changed — is [`LICENSE`](LICENSE). The summary:
179
 
180
  | Archives | License we grant | Source |
181
  |---|---|---|
@@ -207,11 +232,11 @@ for a particular purpose.
207
  ## Citing
208
 
209
  Cite the upstream database for whichever archive you used — each entry in
210
- [`LICENSE`](LICENSE) carries its `Cite` line. For the pipeline itself, see the
211
  [Thal-Kak repository](https://github.com/CSSB-SNU/Thal-Kak).
212
 
213
  ## Links
214
 
215
  - Pipeline: <https://github.com/CSSB-SNU/Thal-Kak>
216
  - Installer documentation: `install/README.md` in that repository
217
- - Per-archive provenance and licensing: [`LICENSE`](LICENSE)
 
12
  - NA
13
  ---
14
 
 
15
  # Thal-Kak local MSA, template databases
16
 
17
  The sequence and template databases that the local MSA modes of
 
27
  > **These are derived databases, not upstream mirrors.** Each archive was
28
  > re-clustered and/or reformatted here. Numbers computed on them will not match
29
  > numbers computed on the upstream distribution. What was changed is recorded
30
+ > per source in [`LICENSE`](https://huggingface.co/datasets/cssbsnu/Thal-Kak_local_db/blob/main/LICENSE), under `Changes`.
31
 
32
  ## At a glance
33
 
 
143
  pip install -U "huggingface_hub[cli]"
144
 
145
  hf download cssbsnu/Thal-Kak_local_db --repo-type dataset \
146
+ --include "hhblits/envhog.tar.zst" "LICENSE" --local-dir ./dl
147
  ```
148
 
149
+ `--include` filters the whole repo, so name `LICENSE` alongside the archives —
150
+ otherwise the terms that govern what you just downloaded stay behind on the
151
+ Hub. A plain `hf download <repo> --repo-type dataset` takes everything and
152
+ needs no such care.
153
+
154
  Unpacking by hand is possible (`zstd -dc <archive> | tar -x -C <dir>`) but you
155
  then have to reproduce the layout yourself: each database lives at
156
  `<family root>/<key>/`, with every file inside renamed from its build-time stem
 
173
  Everything, all four families: **5.41 TiB** installed, ~5.7 TiB peak when
174
  installed family by family.
175
 
176
+ ## Integrity
177
+
178
+ `install_db.sh` checks these automatically. To verify a manual download:
179
+
180
+ ```bash
181
+ sha256sum -c <<'SUMS'
182
+ 4870b0e13856dcc3f024ff15c6b9b4a34ea6a2072b12a7bd30c1e0f78e35a601 mmseqs/uniref100_2026_01.tar.zst
183
+ 1710e951f0d8e18622c0daa82065c0e571e17f4c0a56594be06fd8ddd4688694 mmseqs/bfd_reduced.tar.zst
184
+ 0b366a52685a5359daecca933d8d072e43db01da2fb4bf73ce4b9b394ee8d485 mmseqs/mgnify_clusters.tar.zst
185
+ 342935bcace264cc26cd554781a33e0c820ce16a5486eb81d05ce5b91963c9cc mmseqs/logan_human.tar.zst
186
+ 7cc390b189b72ed46af69952355466759e6db4f7abd3ac83d9b83f2b7c8243a5 mmseqs/envhog_std.tar.zst
187
+ 15a2efae5962ede25872eb29bcbf28165b373b100d57dfa86e3aab26e72ba8fd template/BioMolDB_20260224.tar.zst
188
+ 583b3fa79958e68699dac17c26a1dd61dbee3a88d10295bbad0f29e93472c41d hhblits/uniref100.tar.zst
189
+ e6d0e30fb4699e2137696505945feb57163e991efa868bae1e85acd7a9610358 hhblits/uniref30_2023_02.tar.zst
190
+ fc5385d6e42ef4a3589323d66c503264eb50cb1024d44d8384443c598450eb1f hhblits/mgnify_clusters.tar.zst
191
+ a6db507c0b7204a2d8e1bc9b7cdd9d3c811450ae9625e9620ea3b3b878eefca6 hhblits/logan_human.tar.zst
192
+ 4948bb337a6c58811a7b41a73f27f725a45006c0db309f49e124d4252e1be0c3 hhblits/logan_nonhuman.tar.zst
193
+ 2ab6318847d65b877b8e3e28418ebf8fbd64e0ab7b80d9beb89227b4bad8fa0d hhblits/envhog.tar.zst
194
+ SUMS
195
+ ```
196
+
197
  ## License and attribution
198
 
199
  **The Apache-2.0 license on the Thal-Kak source code does not apply to anything
200
  in this repository.** Each archive carries the license of the source it derives
201
  from; no archive mixes sources. The authoritative record — upstream license,
202
  the license we place on our archive, attribution, citation, and exactly what we
203
+ changed — is [`LICENSE`](https://huggingface.co/datasets/cssbsnu/Thal-Kak_local_db/blob/main/LICENSE). The summary:
204
 
205
  | Archives | License we grant | Source |
206
  |---|---|---|
 
232
  ## Citing
233
 
234
  Cite the upstream database for whichever archive you used — each entry in
235
+ [`LICENSE`](https://huggingface.co/datasets/cssbsnu/Thal-Kak_local_db/blob/main/LICENSE) carries its `Cite` line. For the pipeline itself, see the
236
  [Thal-Kak repository](https://github.com/CSSB-SNU/Thal-Kak).
237
 
238
  ## Links
239
 
240
  - Pipeline: <https://github.com/CSSB-SNU/Thal-Kak>
241
  - Installer documentation: `install/README.md` in that repository
242
+ - Per-archive provenance and licensing: [`LICENSE`](https://huggingface.co/datasets/cssbsnu/Thal-Kak_local_db/blob/main/LICENSE)