-
Notifications
You must be signed in to change notification settings - Fork 3
/
showyourwork.html
210 lines (167 loc) · 9.05 KB
/
showyourwork.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<meta name="description"
content="An open source Doppler imaging code for mapping stellar surfaces.">
<meta name="author" content="Rodrigo Luger">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>show your work!</title>
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/fontawesome.css">
<!-- Main css -->
<link rel="stylesheet" href="css/custom.css">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-47070068-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-47070068-1');
</script>
</head>
<body>
<!-- PRE LOADER -->
<div class="preloader">
<div class="spinner">
<div class="dot1"></div>
<div class="dot2"></div>
</div>
</div>
<!-- Navigation section -->
<div class="navbar navbar-default navbar-static-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="icon icon-bar"></span>
<span class="icon icon-bar"></span>
<span class="icon icon-bar"></span>
</button>
<a href="index.html" class="navbar-brand">
<span class="avatar">
<img src="images/rodrigo-luger-avatar.jpg">
</span>
</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav navbar-right">
<li class="active"><a href="index.html">home</a></li>
<li><a href="about.html">about</a></li>
<li><a href="https://github.com/rodluger/cv/raw/master/luger_cv_industry.pdf">cv</a></li>
<li><a href="https://github.com/rodluger/cv/raw/master-pdf/luger_cv.pdf">astro cv</a></li>
<li><a href="blog/index.html" class="blinker">blog</a></li>
</ul>
</div>
</div>
</div>
<!-- Single Project Section -->
<section id="single-project">
<div class="container">
<div class="row">
<div class="col-md-offset-1 col-md-10 col-sm-12">
<h1>showyourwork!</h1>
<div class="project-links">
<div class="project-link">
<a href="https://github.com/rodluger/showyourwork" data-toggle="tooltip"
data-placement="bottom" title="code">
<i class="fab fa-github"></i>
</a>
</div>
<div class="project-link">
<a href="https://showyourwork.readthedocs.io/en/stable/" data-toggle="tooltip"
data-placement="bottom" title="docs">
<i class="fas fa-info-circle"></i>
</a>
</div>
<div class="project-link">
<a href="https://ui.adsabs.harvard.edu/abs/2021arXiv211006271L"
data-toggle="tooltip" data-placement="bottom" title="sample paper">
<i class="far fa-file-alt"></i>
</a>
</div>
</div>
<div class="single-project-figure">
<div class="blog-image-container full-width">
<img src="images/showyourwork-phil.jpg" width='100%'>
</img>
</div>
<p>
</p>
</div>
<p>
The showyourwork workflow is intended to help authors publish the code that generated the figures and results in a scientific article.
It ensures that the compiled article PDF is always in sync with all of the code used to generate it. It does this
automatically—and seamlessly—with the help of the Snakemake workflow management system, the tectonic typesetting engine, and Github Actions CI.
</p>
<p>
Within the showyourwork workflow, scientific articles exist as GitHub repositories with a specific layout. Whenever new commits are pushed to the
remote repository, a GitHub action is triggered that automatically builds the article from the input figure scripts, manuscript files, and
conda environment file, following the instructions specified in the Snakefile.
</p>
<br><br>
<div class="single-project-figure">
<div class="blog-image-container full-width">
<img src="images/showyourwork-workflow.png" width='100%'>
</img>
</div>
<p>
</p>
</div>
<p>
The article PDF (along with a tarball containing all of the output) is then pushed to a special branch (usually main-pdf) on the repository.
This article is decorated with badges linking to the exact versions of the files on GitHub used to generate it.
</p>
<p>
Thanks to the magic of Snakemake, showyourwork is both lightweight—it should work out-of-the-box for most users—and highly customizable.
It also uses intelligent caching to never re-run things it doesn’t have to (like figure scripts that haven’t changed), even when running on the cloud.
</p>
<p>
To get started with showyourwork, check out the <a href="https://showyourwork.readthedocs.io/en/stable/quickstart/">quickstart tutorial</a>.
The full documentation is available <a href="https://showyourwork.readthedocs.io/en/stable/">here</a>.
</p>
</div>
</div>
</div>
</section>
<!-- Footer Section -->
<footer>
<div class="container">
<div class="row">
<div class="col-md-3 col-sm-3">
<span class="avatar">
<img src="images/rodrigo-luger-avatar.jpg">
</span>
</div>
<div class="col-md-4 col-sm-4">
<p>162 5th Ave, 5th Floor<br />New York NY 10100 United States</p>
</div>
<div class="col-md-offset-1 col-md-4 col-sm-offset-1 col-sm-3">
<p><a href="mailto:rodluger@gmail.com">rodluger@gmail.com</a> <br /> <img src="images/cel.jpg"
style="width:90px;"></img></p>
</div>
<div class="clearfix col-md-12 col-sm-12">
<hr>
</div>
<div class="col-md-6 col-sm-6">
<div class="footer-copyright">
<p>© 2020 Rodrigo Luger   |   <a
href="https://github.com/rodluger/rodluger.github.io">hosted on github</a>
</p>
</div>
</div>
<div class="col-md-6 col-sm-6">
<ul class="social-icon">
<li><a href="https://github.com/rodluger" class="fab fa-github"></a></li>
<li><a href="https://twitter.com/rodluger" class="fab fa-twitter"></a></li>
</ul>
</div>
</div>
</div>
</footer>
<!-- SCRIPTS -->
<script src="js/jquery.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/custom.js"></script>
</body>
</html>