Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
277 lines (260 loc) · 11.6 KB
/
Copy pathindex.html
File metadata and controls
277 lines (260 loc) · 11.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
---
title: Calkit
layout: base
---
<section class="hero">
<div class="container">
<a class="hero-badge" href="https://github.com/calkit/calkit" target="_blank" rel="noopener">
<span class="dot" aria-hidden="true"></span>
Open source, and built on open source
</a>
<h1>
<span class="accent">Single-button reproducible</span> research
projects.
</h1>
<p class="hero-sub">
Instead of a loosely related collection of files split across multiple
systems or apps, "integrated" via manual steps, your project becomes a
version-controlled, self-contained "calculation kit," so you, your
collaborators, and your readers can go from raw data to research article
with a single command.
</p>
<div class="hero-actions">
<a class="btn btn-primary btn-lg" href="https://docs.calkit.org/installation/" target="_blank" rel="noopener">
Get started
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"
stroke-linejoin="round" aria-hidden="true">
<path d="M5 12h14M12 5l7 7-7 7" />
</svg>
</a>
<a class="btn btn-secondary btn-lg" href="https://docs.calkit.org" target="_blank" rel="noopener">
Read the docs
</a>
</div>
<div class="install">
<code><span class="prompt" aria-hidden="true">$</span><span id="install-cmd">curl -LsSf install.calkit.org | sh</span></code>
<button class="copy-btn" type="button" data-copy-target="install-cmd" aria-label="Copy install command"
title="Copy install command">
<svg class="icon-copy" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"
stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
<rect x="8" y="8" width="14" height="14" rx="2" />
<path d="M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2" />
</svg>
<svg class="icon-check" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.2"
stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
<path d="M20 6 9 17l-5-5" />
</svg>
</button>
</div>
<p class="install-note">
Linux, macOS, or Windows. See the
<a href="https://docs.calkit.org/installation/" target="_blank" rel="noopener">installation docs</a>
for other options.
</p>
</div>
</section>
<section class="showcase">
<div class="container">
<figure class="diagram">
<div class="diagram-flow">
<div class="flow-label">
<span>Research<br />questions</span>
<svg class="flow-arrow" viewBox="0 0 60 16" fill="none" aria-hidden="true">
<path d="M2 8h48" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" />
<path d="m48 2 10 6-10 6" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"
stroke-linejoin="round" />
</svg>
</div>
<div class="project">
<span class="project-label">One Calkit project</span>
<!-- Every stage can loop back to any earlier stage, or to itself;
each arrowhead lands on the stage the loop returns to -->
<div class="project-loops" aria-hidden="true">
<span class="loop loop-w-l"></span>
<span class="loop loop-w-d"></span>
<span class="loop loop-a-l"></span>
<span class="loop loop-w-a"></span>
<span class="loop loop-a-d"></span>
<span class="loop loop-d-l"></span>
<span class="loop loop-self loop-self-1"></span>
<span class="loop loop-self loop-self-2"></span>
<span class="loop loop-self loop-self-3"></span>
<span class="loop loop-self loop-self-4"></span>
</div>
<div class="project-chips project-stages">
<span class="chip"><strong>Lit review, planning</strong><small>references, research questions</small></span>
<span class="chip"><strong>Data collection</strong><small>datasets</small></span>
<span class="chip"><strong>Analysis</strong><small>scripts, notebooks, figures</small></span>
<span class="chip"><strong>Writing</strong><small>publications</small></span>
</div>
</div>
<div class="flow-label">
<span>Reproducible<br />answers</span>
<svg class="flow-arrow" viewBox="0 0 60 16" fill="none" aria-hidden="true">
<path d="M2 8h48" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" />
<path d="m48 2 10 6-10 6" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"
stroke-linejoin="round" />
</svg>
</div>
</div>
<figcaption class="visually-hidden">
Research questions feed into a single Calkit project whose stages,
literature review and planning, data collection, analysis, and
writing, feed forward into one another, and every stage can loop
back to any earlier stage or to itself, producing reproducible
evidence to back up the answers.
</figcaption>
</figure>
</div>
</section>
<section class="section">
<div class="container">
<div class="section-head">
<span class="eyebrow">The tools already exist</span>
<h2>And yet most projects fail to reproduce.</h2>
<p>
The tools to create single-button reproducible research projects
already exist, e.g., version control with Git, environment management
with uv, Make for a build system or pipeline, and LaTeX for document
compilation. If you and your team can work effectively with a system
like that, there's no need for any additional complexity. And yet these
practices are still not common. What happens in reality is that the
costs are deemed too high and the benefit too low, so workflows remain
manual and fragmented, and many team members are not able to contribute
to their full potential.
</p>
</div>
<div class="stats">
<a class="stat" href="https://doi.org/10.1038/s41597-022-01143-6" target="_blank" rel="noopener">
<span class="stat-number">74%</span>
<span class="stat-label">of R files in published replication packages fail to run</span>
</a>
<a class="stat" href="https://doi.org/10.1093/gigascience/giad113" target="_blank" rel="noopener">
<span class="stat-number">3%</span>
<span class="stat-label">of Jupyter notebooks attached to biomedical papers reproduce their results</span>
</a>
<a class="stat" href="https://doi.org/10.1073/pnas.1708290115" target="_blank" rel="noopener">
<span class="stat-number">~25%</span>
<span class="stat-label">of claims are reproduced from the code and data journals collect</span>
</a>
</div>
</div>
</section>
<section class="section section-continued">
<div class="container">
<div class="section-head">
<span class="eyebrow">Why Calkit</span>
<h2>Success comes from iteration, and iteration is made possible through integration.</h2>
</div>
<div class="grid grid-4">
<div class="card">
<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round"
stroke-linejoin="round" aria-hidden="true">
<path
d="M12.83 2.18a2 2 0 0 0-1.66 0L2.6 6.08a1 1 0 0 0 0 1.83l8.57 3.91a2 2 0 0 0 1.66 0l8.58-3.9a1 1 0 0 0 0-1.83Z" />
<path d="m22 17.65-9.17 4.16a2 2 0 0 1-1.66 0L2 17.65" />
<path d="m22 12.65-9.17 4.16a2 2 0 0 1-1.66 0L2 12.65" />
</svg>
</div>
<h3>One lifecycle, one project</h3>
<p>
Calkit allows all stages of a research project to live in the same
repository, making feedback loops both inside and across stages fast
and painless, providing full context to both humans and AI agents.
</p>
</div>
<div class="card">
<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round"
stroke-linejoin="round" aria-hidden="true">
<path d="M10 13a5 5 0 0 0 7.5.5l3-3a5 5 0 0 0-7-7l-1.7 1.7" />
<path d="M14 11a5 5 0 0 0-7.5-.5l-3 3a5 5 0 0 0 7 7l1.7-1.7" />
</svg>
</div>
<h3>Coupled components close together</h3>
<p>
A change in a dataset requires reanalyzing, which creates a change in
a figure, which creates a change in a research article. Software
teams learned this long ago, integrating development, testing,
deployment, and infrastructure into the same repo. Similar
productivity and quality gains can be had in research.
</p>
</div>
<div class="card">
<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round"
stroke-linejoin="round" aria-hidden="true">
<rect x="3" y="11" width="18" height="11" rx="2" />
<path d="M7 11V7a5 5 0 0 1 9.9-1" />
</svg>
</div>
<h3>Lock in without lock-in</h3>
<p>
Everything is connected right out of the box, with a CLI, web app,
and more to reduce friction for every task and team member involved.
The underlying tools can be used directly by more tolerant team
members, and others can contribute at a higher level while
maintaining single-button reproducibility.
</p>
</div>
<div class="card">
<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round"
stroke-linejoin="round" aria-hidden="true">
<circle cx="11" cy="11" r="7" />
<path d="m21 21-4.3-4.3" />
<path d="m8.5 11 2 2 3.5-4" />
</svg>
</div>
<h3>Defined provenance</h3>
<p>
The project information in <code>calkit.yaml</code> gives a full
picture: its research questions, the artifacts generated as evidence
to answer them, and a way to verify everything back to its origin,
including whether a figure or table is stale with respect to its
input data. Critical when using generative AI.
</p>
</div>
</div>
</div>
</section>
<section class="section section-continued">
<div class="container">
<h2 class="pills-heading">Works with the tools you already use</h2>
<ul class="pills">
<li>Git</li>
<li>Docker</li>
<li>DVC</li>
<li>Python</li>
<li>R</li>
<li>MATLAB</li>
<li>LaTeX</li>
<li>Overleaf</li>
<li>Julia</li>
<li>Jupyter</li>
</ul>
</div>
</section>
<section class="section section-continued">
<div class="container">
<div class="cta">
<h2>Start unifying and simplifying</h2>
<p>
Install Calkit, run through a tutorial, and move faster today.
</p>
<div class="hero-actions cta-actions">
<a class="btn btn-primary btn-lg" href="https://docs.calkit.org/installation/" target="_blank" rel="noopener">
Get started
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"
stroke-linejoin="round" aria-hidden="true">
<path d="M5 12h14M12 5l7 7-7 7" />
</svg>
</a>
<a class="btn btn-secondary btn-lg" href="https://docs.calkit.org/tutorials/" target="_blank" rel="noopener">
Browse tutorials
</a>
</div>
</div>
</div>
</section>