Cameron Smith commited on
Commit
11af8fa
·
unverified ·
1 Parent(s): 8781e4e

docs: add repository documentation with upstream attribution

Browse files
Files changed (1) hide show
  1. README.md +94 -0
README.md ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ pretty_name: SciExp Fixtures
4
+ tags:
5
+ - test-fixtures
6
+ - duckdb
7
+ - ducklake
8
+ size_categories:
9
+ - n<1K
10
+ ---
11
+
12
+ # sciexp/fixtures
13
+
14
+ Test fixtures and example datasets for [sciexp](https://github.com/sciexp).
15
+
16
+ ## Quick start
17
+
18
+ ```sh
19
+ git clone https://huggingface.co/datasets/sciexp/fixtures
20
+ cd fixtures
21
+ git lfs pull
22
+ ```
23
+
24
+ ## Datasets
25
+
26
+ ### Space dataset
27
+
28
+ A relational dataset about space exploration demonstrating DuckLake workflows.
29
+ Contains tables for astronauts, missions, spacecraft, and mission crew assignments.
30
+
31
+ ```sh
32
+ duckdb -box < queries/space.sql
33
+ ```
34
+
35
+ <details>
36
+ <summary>Manual DuckDB session</summary>
37
+
38
+ Attach directly from Hugging Face:
39
+
40
+ ```sql
41
+ INSTALL ducklake;
42
+ LOAD ducklake;
43
+ ATTACH 'ducklake:hf://datasets/sciexp/fixtures/lakes/frozen/space.db' AS space;
44
+ SHOW TABLES FROM space.main;
45
+ ```
46
+
47
+ Or from a local clone:
48
+
49
+ ```sql
50
+ ATTACH 'ducklake:lakes/frozen/space.db' AS space;
51
+ ```
52
+
53
+ </details>
54
+
55
+ ## Attribution
56
+
57
+ The space missions dataset originates from:
58
+
59
+ - [marhar/frozen](https://github.com/marhar/frozen) - Frozen DuckLake Demo
60
+ - [marhar/duckdb_tools](https://github.com/marhar/duckdb_tools) - DuckDB tools including frozen-ducklake workflow scripts
61
+
62
+ ## Repository layout
63
+
64
+ <details>
65
+ <summary>Directory structure</summary>
66
+
67
+ ```
68
+ lakes/frozen/ DuckLake databases
69
+ space.db Metadata database
70
+ space/ Parquet data files
71
+ queries/ SQL scripts
72
+ ```
73
+
74
+ </details>
75
+
76
+ ## Contributing
77
+
78
+ <details>
79
+ <summary>Authentication and push workflow</summary>
80
+
81
+ Push access requires Hugging Face authentication:
82
+
83
+ ```sh
84
+ hf auth login --token "${HF_TOKEN}" --add-to-git-credential
85
+ ```
86
+
87
+ Push changes:
88
+
89
+ ```sh
90
+ git lfs push --all origin
91
+ git push
92
+ ```
93
+
94
+ </details>