-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
585 lines (569 loc) · 22.8 KB
/
Copy pathdocs.html
File metadata and controls
585 lines (569 loc) · 22.8 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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="LARUN.SPACE Documentation - Learn how to use the exoplanet detection API">
<title>Documentation - Larun.</title>
<link href="https://fonts.googleapis.com/css2?family=Google+Sans:wght@400;500;700&family=Roboto:wght@300;400;500&family=Roboto+Mono:wght@400;500&display=swap" rel="stylesheet">
<link rel="icon" type="image/svg+xml" href="assets/logo.svg">
<style>
* { margin: 0; padding: 0; box-sizing: border-box; }
:root {
--black: #202124;
--dark-gray: #3c4043;
--medium-gray: #5f6368;
--light-gray: #dadce0;
--lighter-gray: #f1f3f4;
--white: #ffffff;
--primary: #1a73e8;
--primary-light: #e8f0fe;
--success: #137333;
--error: #c5221f;
--border-radius: 8px;
--shadow: 0 1px 2px 0 rgba(60,64,67,0.3), 0 1px 3px 1px rgba(60,64,67,0.15);
}
body {
font-family: 'Google Sans', 'Roboto', sans-serif;
background: var(--lighter-gray);
color: var(--black);
line-height: 1.6;
}
/* Navigation */
.top-nav {
position: fixed;
top: 0;
left: 0;
right: 0;
height: 64px;
background: var(--white);
border-bottom: 1px solid var(--light-gray);
display: flex;
align-items: center;
padding: 0 24px;
z-index: 100;
}
.nav-left {
display: flex;
align-items: center;
gap: 8px;
}
.logo {
font-size: 22px;
font-weight: 500;
color: var(--black);
text-decoration: none;
}
.logo span { color: var(--medium-gray); }
.product-name {
font-size: 14px;
color: var(--medium-gray);
font-weight: 400;
padding-left: 8px;
border-left: 1px solid var(--light-gray);
margin-left: 8px;
}
.nav-center {
flex: 1;
display: flex;
justify-content: center;
gap: 8px;
}
.nav-link {
padding: 8px 16px;
color: var(--dark-gray);
text-decoration: none;
font-size: 14px;
font-weight: 500;
border-radius: 4px;
}
.nav-link:hover { background: var(--lighter-gray); }
.nav-link.active { color: var(--primary); }
.nav-right {
display: flex;
align-items: center;
gap: 12px;
}
.btn {
padding: 8px 20px;
border-radius: 4px;
font-size: 14px;
font-weight: 500;
cursor: pointer;
text-decoration: none;
border: none;
font-family: inherit;
}
.btn-primary {
background: var(--black);
color: var(--white);
}
.btn-secondary {
background: var(--white);
color: var(--dark-gray);
border: 1px solid var(--light-gray);
}
/* Layout */
.docs-layout {
display: flex;
margin-top: 64px;
min-height: calc(100vh - 64px);
}
.docs-sidebar {
width: 260px;
background: var(--white);
border-right: 1px solid var(--light-gray);
padding: 24px 16px;
position: fixed;
top: 64px;
bottom: 0;
overflow-y: auto;
}
.nav-section { margin-bottom: 24px; }
.nav-section-title {
font-size: 11px;
font-weight: 500;
color: var(--medium-gray);
text-transform: uppercase;
letter-spacing: 0.5px;
padding: 8px 12px;
}
.nav-section-links { display: flex; flex-direction: column; }
.sidebar-link {
padding: 8px 12px;
color: var(--dark-gray);
text-decoration: none;
font-size: 14px;
border-radius: 4px;
}
.sidebar-link:hover { background: var(--lighter-gray); }
.sidebar-link.active {
background: var(--primary-light);
color: var(--primary);
}
/* Content */
.docs-content {
flex: 1;
margin-left: 260px;
padding: 32px 48px;
max-width: 900px;
}
.docs-content h1 {
font-size: 32px;
font-weight: 400;
margin-bottom: 16px;
color: var(--black);
}
.docs-content h2 {
font-size: 24px;
font-weight: 500;
margin: 32px 0 16px;
padding-top: 24px;
border-top: 1px solid var(--light-gray);
color: var(--black);
}
.docs-content h3 {
font-size: 18px;
font-weight: 500;
margin: 24px 0 12px;
color: var(--dark-gray);
}
.docs-content h4 {
font-size: 14px;
font-weight: 500;
margin: 16px 0 8px;
color: var(--dark-gray);
}
.docs-content p {
margin-bottom: 16px;
color: var(--dark-gray);
}
.docs-content ul, .docs-content ol {
margin-bottom: 16px;
padding-left: 24px;
}
.docs-content li {
margin-bottom: 8px;
color: var(--dark-gray);
}
.docs-content a {
color: var(--primary);
text-decoration: none;
}
.docs-content a:hover { text-decoration: underline; }
.docs-content code {
font-family: 'Roboto Mono', monospace;
font-size: 13px;
background: var(--lighter-gray);
padding: 2px 6px;
border-radius: 4px;
color: var(--dark-gray);
}
.docs-content pre {
background: var(--black);
color: var(--white);
padding: 16px;
border-radius: 8px;
overflow-x: auto;
margin: 16px 0;
}
.docs-content pre code {
background: none;
padding: 0;
color: inherit;
font-size: 13px;
}
/* Endpoint Cards */
.endpoint-card {
background: var(--white);
border: 1px solid var(--light-gray);
border-radius: 8px;
margin: 16px 0;
overflow: hidden;
}
.endpoint-header {
display: flex;
align-items: center;
gap: 12px;
padding: 12px 16px;
background: var(--lighter-gray);
border-bottom: 1px solid var(--light-gray);
}
.endpoint-method {
font-family: 'Roboto Mono', monospace;
font-size: 12px;
font-weight: 500;
padding: 4px 8px;
border-radius: 4px;
background: var(--primary);
color: var(--white);
}
.endpoint-method.get { background: #137333; }
.endpoint-path {
font-family: 'Roboto Mono', monospace;
font-size: 14px;
color: var(--black);
}
.endpoint-body { padding: 16px; }
.param-table {
width: 100%;
border-collapse: collapse;
margin: 12px 0;
font-size: 13px;
}
.param-table th, .param-table td {
padding: 10px 12px;
text-align: left;
border-bottom: 1px solid var(--light-gray);
}
.param-table th {
font-size: 11px;
font-weight: 500;
color: var(--medium-gray);
text-transform: uppercase;
}
.param-name {
font-family: 'Roboto Mono', monospace;
color: var(--primary);
}
.param-type {
font-family: 'Roboto Mono', monospace;
color: var(--medium-gray);
font-size: 12px;
}
.param-required {
font-size: 10px;
color: var(--error);
margin-left: 4px;
}
/* Footer */
.footer {
margin-left: 260px;
padding: 32px 48px;
border-top: 1px solid var(--light-gray);
background: var(--white);
}
.footer-links {
display: flex;
gap: 24px;
margin-bottom: 16px;
}
.footer-links a {
color: var(--medium-gray);
text-decoration: none;
font-size: 14px;
}
.footer-links a:hover { color: var(--dark-gray); }
.footer p {
font-size: 12px;
color: var(--medium-gray);
}
@media (max-width: 768px) {
.docs-sidebar { display: none; }
.docs-content, .footer { margin-left: 0; padding: 24px; }
.nav-center { display: none; }
}
</style>
</head>
<body>
<nav class="top-nav">
<div class="nav-left">
<a href="index.html" class="logo">Larun<span>.</span></a>
<span class="product-name">AstroTinyML</span>
</div>
<div class="nav-center">
<a href="index.html" class="nav-link">Home</a>
<a href="dashboard.html" class="nav-link">Dashboard</a>
<a href="pricing.html" class="nav-link">Pricing</a>
<a href="docs.html" class="nav-link active">Docs</a>
<a href="download.html" class="nav-link">Download</a>
</div>
<div class="nav-right">
<a href="dashboard.html" class="btn btn-primary">Get Started</a>
</div>
</nav>
<div class="docs-layout">
<nav class="docs-sidebar">
<div class="nav-section">
<div class="nav-section-title">Getting Started</div>
<div class="nav-section-links">
<a href="#introduction" class="sidebar-link active">Introduction</a>
<a href="#quickstart" class="sidebar-link">Quick Start</a>
<a href="#authentication" class="sidebar-link">Authentication</a>
</div>
</div>
<div class="nav-section">
<div class="nav-section-title">API Reference</div>
<div class="nav-section-links">
<a href="#api-overview" class="sidebar-link">Overview</a>
<a href="#bls-endpoint" class="sidebar-link">BLS Analysis</a>
<a href="#fit-endpoint" class="sidebar-link">Transit Fitting</a>
<a href="#classify-endpoint" class="sidebar-link">Star Classification</a>
<a href="#hz-endpoint" class="sidebar-link">Habitable Zone</a>
<a href="#pipeline-endpoint" class="sidebar-link">Full Pipeline</a>
</div>
</div>
<div class="nav-section">
<div class="nav-section-title">More Guides</div>
<div class="nav-section-links">
<a href="guide.html" class="sidebar-link">User Guide</a>
<a href="models.html" class="sidebar-link">TinyML Models</a>
<a href="workflow.html" class="sidebar-link">How It Works</a>
<a href="tips.html" class="sidebar-link">Tips & Tricks</a>
<a href="faq.html" class="sidebar-link">FAQ</a>
</div>
</div>
</nav>
<main class="docs-content">
<h1 id="introduction">Documentation</h1>
<p>Welcome to Larun documentation. This guide covers everything you need to know to discover exoplanets using our TinyML-powered detection system.</p>
<h2 id="quickstart">Quick Start</h2>
<p>The fastest way to get started is through the <a href="dashboard.html">Dashboard</a>. Navigate to the Detect tool and enter a target ID to analyze.</p>
<h3>Example: Search for Transits</h3>
<p>Enter a TIC ID in the detection form:</p>
<pre><code>TIC 307210830</code></pre>
<p>Larun will automatically fetch the light curve from NASA TESS, run TinyML detection, and present you with the results.</p>
<h2 id="authentication">Authentication</h2>
<p>Free tier users can analyze up to 10 targets per month without authentication. For unlimited access and API usage, create an account and subscribe to a paid plan.</p>
<h3>API Authentication</h3>
<p>For programmatic access, include your API key in the request header:</p>
<pre><code>Authorization: Bearer YOUR_API_KEY</code></pre>
<h2 id="api-overview">API Overview</h2>
<p>The Larun API provides programmatic access to all detection and analysis features. Base URL:</p>
<pre><code>https://api.larun.space/v1</code></pre>
<h2 id="bls-endpoint">BLS Analysis</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="endpoint-method">POST</span>
<span class="endpoint-path">/analyze/bls</span>
</div>
<div class="endpoint-body">
<p>Run Box Least Squares periodogram analysis to detect transit signals.</p>
<h4>Parameters</h4>
<table class="param-table">
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
</thead>
<tbody>
<tr>
<td><span class="param-name">tic_id</span><span class="param-required">required</span></td>
<td><span class="param-type">string</span></td>
<td>TIC identifier (e.g., "307210830")</td>
</tr>
<tr>
<td><span class="param-name">period_min</span></td>
<td><span class="param-type">float</span></td>
<td>Minimum period to search (days). Default: 0.5</td>
</tr>
<tr>
<td><span class="param-name">period_max</span></td>
<td><span class="param-type">float</span></td>
<td>Maximum period to search (days). Default: 15.0</td>
</tr>
</tbody>
</table>
<h4>Example Request</h4>
<pre><code>curl -X POST https://api.larun.space/v1/analyze/bls \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"tic_id": "307210830", "period_min": 0.5, "period_max": 15.0}'</code></pre>
<h4>Response</h4>
<pre><code>{
"status": "success",
"period": 3.4254,
"depth": 0.0023,
"snr": 12.4,
"is_candidate": true
}</code></pre>
</div>
</div>
<h2 id="fit-endpoint">Transit Fitting</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="endpoint-method">POST</span>
<span class="endpoint-path">/analyze/fit</span>
</div>
<div class="endpoint-body">
<p>Fit transit model to derive planetary parameters.</p>
<table class="param-table">
<thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td><span class="param-name">tic_id</span><span class="param-required">required</span></td>
<td><span class="param-type">string</span></td>
<td>TIC identifier</td>
</tr>
<tr>
<td><span class="param-name">period</span><span class="param-required">required</span></td>
<td><span class="param-type">float</span></td>
<td>Orbital period in days</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="classify-endpoint">Star Classification</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="endpoint-method">POST</span>
<span class="endpoint-path">/stellar/classify</span>
</div>
<div class="endpoint-body">
<p>Classify the host star and retrieve stellar parameters.</p>
<table class="param-table">
<thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td><span class="param-name">tic_id</span><span class="param-required">required</span></td>
<td><span class="param-type">string</span></td>
<td>TIC identifier</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="hz-endpoint">Habitable Zone</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="endpoint-method">POST</span>
<span class="endpoint-path">/planet/hz</span>
</div>
<div class="endpoint-body">
<p>Check if a planet candidate is within the habitable zone.</p>
<table class="param-table">
<thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td><span class="param-name">stellar_teff</span><span class="param-required">required</span></td>
<td><span class="param-type">float</span></td>
<td>Stellar effective temperature (K)</td>
</tr>
<tr>
<td><span class="param-name">stellar_luminosity</span><span class="param-required">required</span></td>
<td><span class="param-type">float</span></td>
<td>Stellar luminosity (solar units)</td>
</tr>
<tr>
<td><span class="param-name">semi_major_axis</span><span class="param-required">required</span></td>
<td><span class="param-type">float</span></td>
<td>Planet semi-major axis (AU)</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="pipeline-endpoint">Full Pipeline</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="endpoint-method">POST</span>
<span class="endpoint-path">/pipeline</span>
</div>
<div class="endpoint-body">
<p>Run the complete exoplanet detection and characterization pipeline.</p>
<table class="param-table">
<thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr>
<td><span class="param-name">tic_id</span><span class="param-required">required</span></td>
<td><span class="param-type">string</span></td>
<td>TIC identifier</td>
</tr>
<tr>
<td><span class="param-name">full_report</span></td>
<td><span class="param-type">boolean</span></td>
<td>Generate full PDF report. Default: false</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="data-sources">Data Sources</h2>
<p>Larun uses data from the following NASA missions:</p>
<ul>
<li><strong>TESS:</strong> Transiting Exoplanet Survey Satellite</li>
<li><strong>Kepler:</strong> Kepler Space Telescope (Scientist tier)</li>
<li><strong>JWST:</strong> James Webb Space Telescope spectroscopy (Scientist tier)</li>
</ul>
<h2 id="limitations">Limitations</h2>
<ul>
<li>TinyML detection accuracy: 81.8% (may produce false positives)</li>
<li>Period search range: 0.5 - 15 days (configurable)</li>
<li>Minimum transit depth: ~0.1% (depends on stellar noise)</li>
<li>API rate limits apply based on subscription tier</li>
</ul>
</main>
</div>
<footer class="footer">
<div class="footer-links">
<a href="https://laruneng.com" target="_blank">laruneng.com</a>
<a href="https://github.com/Paddy1981/larun" target="_blank">GitHub</a>
<a href="docs.html">Documentation</a>
<a href="pricing.html">Pricing</a>
</div>
<p>© 2026 Larun. AstroTinyML. All rights reserved.</p>
</footer>
<script src="https://cdn.jsdelivr.net/npm/@supabase/supabase-js@2"></script>
<script src="js/auth.js"></script>
<script>
// Highlight active nav link based on scroll position
const sections = document.querySelectorAll('h2[id], h1[id]');
const navLinks = document.querySelectorAll('.sidebar-link');
function highlightNavLink() {
let current = '';
sections.forEach(section => {
const sectionTop = section.offsetTop - 100;
if (window.scrollY >= sectionTop) {
current = section.getAttribute('id');
}
});
navLinks.forEach(link => {
link.classList.remove('active');
if (link.getAttribute('href') === '#' + current) {
link.classList.add('active');
}
});
}
window.addEventListener('scroll', highlightNavLink);
</script>
</body>
</html>