-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathindex.html
154 lines (136 loc) · 10.9 KB
/
index.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
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="/libs/highlight/styles/github.min.css">
<link rel="stylesheet" href="/css/franklin.css">
<link rel="stylesheet" href="/css/poole_hyde.css">
<link rel="stylesheet" href="/css/custom.css">
<link rel="stylesheet" href="/libs/highlight/styles/github-dark.min.css">
<style>
html {font-size: 17px;}
.franklin-content {position: relative; padding-left: 8%; padding-right: 5%; line-height: 1.35em;}
@media (min-width: 940px) {
.franklin-content {width: 100%; margin-left: auto; margin-right: auto;}
}
@media (max-width: 768px) {
.franklin-content {padding-left: 6%; padding-right: 6%;}
}
</style>
<link rel="icon" href="/assets/favicon.png">
<title>Modern Julia Workflows</title>
</head>
<body>
<div class="sidebar">
<div class="container sidebar-sticky">
<div class="sidebar-about">
<h1><a href="/">MoJuWo</a></h1>
<p class="lead">Modern Julia Workflows</p>
<div class="logo-container">
<img src="/assets/logo.svg" alt="MoJuWo Logo" class="logo-img">
</div>
</div>
<nav class="sidebar-nav">
<a class="sidebar-nav-item active" href="/">Home</a>
<ul class="menu-list-child-list active">
<li class="menu-list-item"><a href="/#goals" class="menu-list-link">Goals</a>
<li class="menu-list-item"><a href="/#contents" class="menu-list-link">Contents</a>
<li class="menu-list-item"><a href="/#before_you_start" class="menu-list-link">Before you start</a>
</ul>
<a class="sidebar-nav-item " href="/writing/">Writing</a>
<ul class="menu-list-child-list ">
<li class="menu-list-item"><a href="/writing/#getting_help" class="menu-list-link">Getting help</a>
<li class="menu-list-item"><a href="/writing/#installation" class="menu-list-link">Installation</a>
<li class="menu-list-item"><a href="/writing/#repl" class="menu-list-link">REPL</a>
<li class="menu-list-item"><a href="/writing/#editor" class="menu-list-link">Editor</a>
<li class="menu-list-item"><a href="/writing/#running_code" class="menu-list-link">Running code</a>
<li class="menu-list-item"><a href="/writing/#notebooks" class="menu-list-link">Notebooks</a>
<li class="menu-list-item"><a href="/writing/#environments" class="menu-list-link">Environments</a>
<li class="menu-list-item"><a href="/writing/#local_packages" class="menu-list-link">Local packages</a>
<li class="menu-list-item"><a href="/writing/#development_workflow" class="menu-list-link">Development workflow</a>
<li class="menu-list-item"><a href="/writing/#configuration" class="menu-list-link">Configuration</a>
<li class="menu-list-item"><a href="/writing/#interactivity" class="menu-list-link">Interactivity</a>
<li class="menu-list-item"><a href="/writing/#logging" class="menu-list-link">Logging</a>
<li class="menu-list-item"><a href="/writing/#debugging" class="menu-list-link">Debugging</a>
</ul>
<a class="sidebar-nav-item " href="/sharing/">Sharing</a>
<ul class="menu-list-child-list ">
<li class="menu-list-item"><a href="/sharing/#setup" class="menu-list-link">Setup</a>
<li class="menu-list-item"><a href="/sharing/#github_actions" class="menu-list-link">GitHub Actions</a>
<li class="menu-list-item"><a href="/sharing/#testing" class="menu-list-link">Testing</a>
<li class="menu-list-item"><a href="/sharing/#style" class="menu-list-link">Style</a>
<li class="menu-list-item"><a href="/sharing/#code_quality" class="menu-list-link">Code quality</a>
<li class="menu-list-item"><a href="/sharing/#documentation" class="menu-list-link">Documentation</a>
<li class="menu-list-item"><a href="/sharing/#literate_programming" class="menu-list-link">Literate programming</a>
<li class="menu-list-item"><a href="/sharing/#versions_and_registration" class="menu-list-link">Versions and registration</a>
<li class="menu-list-item"><a href="/sharing/#reproducibility" class="menu-list-link">Reproducibility</a>
<li class="menu-list-item"><a href="/sharing/#interoperability" class="menu-list-link">Interoperability</a>
<li class="menu-list-item"><a href="/sharing/#collaboration" class="menu-list-link">Collaboration</a>
</ul>
<a class="sidebar-nav-item " href="/optimizing/">Optimizing</a>
<ul class="menu-list-child-list ">
<li class="menu-list-item"><a href="/optimizing/#principles" class="menu-list-link">Principles</a>
<li class="menu-list-item"><a href="/optimizing/#measurements" class="menu-list-link">Measurements</a>
<li class="menu-list-item"><a href="/optimizing/#profiling" class="menu-list-link">Profiling</a>
<li class="menu-list-item"><a href="/optimizing/#type_stability" class="menu-list-link">Type stability</a>
<li class="menu-list-item"><a href="/optimizing/#memory_management" class="menu-list-link">Memory management</a>
<li class="menu-list-item"><a href="/optimizing/#compilation" class="menu-list-link">Compilation</a>
<li class="menu-list-item"><a href="/optimizing/#parallelism" class="menu-list-link">Parallelism</a>
<li class="menu-list-item"><a href="/optimizing/#efficient_types" class="menu-list-link">Efficient types</a>
</ul>
<a class="sidebar-nav-item " href="/further/">Going further</a>
<ul class="menu-list-child-list ">
<li class="menu-list-item"><a href="/further/#official" class="menu-list-link">Official</a>
<li class="menu-list-item"><a href="/further/#tutorials" class="menu-list-link">Tutorials</a>
<li class="menu-list-item"><a href="/further/#blogs" class="menu-list-link">Blogs</a>
<li class="menu-list-item"><a href="/further/#videos" class="menu-list-link">Videos</a>
<li class="menu-list-item"><a href="/further/#lore" class="menu-list-link">Lore</a>
</ul>
</nav>
<p class="copyright-notice">
<a href="https://github.com/modernjuliaworkflows/modernjuliaworkflows.github.io/blob/main/LICENSE">
© G. Dalle, J. Smit, A. Hill.
</a>
</p>
<div class="github-link">
<a href="https://github.com/modernjuliaworkflows/modernjuliaworkflows.github.io">
<svg xmlns="http://www.w3.org/2000/svg" height="28px" fill="currentColor" viewBox="0 0 496 512">
<path
d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" />
</svg>
</a>
</div>
</div>
</div>
<div class="content container">
<div class="franklin-content" >
<h1 id="modern_julia_workflows" ><a href="#modern_julia_workflows"> Modern Julia Workflows</a></h1><p>A series of blog posts on best practices for Julia development.
Consider this a draft: once the posts are ready, we will submit them to the <a href="https://julialang.org/blog/">Julia language blog</a> to make them easily discoverable.
If you find our project useful, please star the <a href="https://github.com/modernjuliaworkflows/modernjuliaworkflows.github.io">GitHub repo</a>!</p>
<div class="toc"><ol><li><a href="#goals">Goals</a></li><li><a href="#contents">Contents</a></li><li><a href="#before_you_start">Before you start</a></li></ol></div><h2 id="goals" ><a href="#goals"> Goals</a></h2><p>Our purpose is to gather the hidden tips and tricks of Julia development, and make them easily accessible to beginners.
We do not cover syntax, and assume that the reader is familiar enough with the <a href="https://julialang.org/learning/">basics of Julia</a>.
Instead, we focus on all the tools that can make the coding experience more pleasant and efficient.</p>
<h2 id="contents" ><a href="#contents"> Contents</a></h2><p>There are three blog posts of increasing technical difficulty, plus one page of additional resources:</p>
<ol>
<li><a href="/writing/">Writing your code</a>: from zero to a basic script</li>
<li><a href="/sharing/">Sharing your code</a>: from a basic script to a reliable package</li>
<li><a href="/optimizing/">Optimizing your code</a>: from a basic script to a light-speed algorithm</li>
<li><a href="/further/">Going further</a>: other websites to help you dive deeper into the rabbit hole</li>
</ol>
<p>These are all fairly long and not meant to be read in one sitting, so take your time.
Keep in mind that while each of these resources <em>can</em> be useful to you, not every one of them <em>will</em> be.
But at least you will know where to look in case you have a specific question.</p>
<h2 id="before_you_start" ><a href="#before_you_start"> Before you start</a></h2><p>Many of the links you will see point to <a href="https://github.com/">GitHub</a> repositories for Julia packages.
When you click them, they will take you to a page called <code>README.md</code> that contains a brief description of the package, sometimes insufficient for actual use.
You can usually find more thorough documentation by clicking on a blue badge called <code>docs|stable</code> looking like this <img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="badge"> at the top of the <code>README</code>.</p>
<div class="page-foot">
<a href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a> G. Dalle, J. Smit, A. Hill. Last modified: January 16, 2025. </br>
Website built with <a href="https://github.com/tlienart/Franklin.jl">Franklin.jl</a> and the <a href="https://julialang.org">Julia programming language</a>.
</div>
</div>
</div>
<script src="/libs/highlight/highlight.min.js"></script>
<script>hljs.highlightAll();hljs.configure({tabReplace: ' '});</script>
</body>
</html>