Hi everyone, After watching a nice video by @jacobusmmsmit yesterday, I sat down and thought about all the lore that experienced Julia users keep in their heads. How to write and share code properly, which packages to use and when, etc. This accumulated knowledge makes our development experience very pleasant, but it is long to acquire and beginners don’t always know where to look. The official documentation is only part of the story: best practices involve a flurry of external packages, which are constantly in flux. I learned a lot from blogs like https://viralinstruction.com/, and so I thought a blog post could be a good idea. But to make it more discoverable and “official” (which is important for newcomers), I want to add it to the Julia blog. Below you’ll find a draft of what I’m hoping to cover. Please contribute to this discussion so that we can achieve something reasonably consensual and complete! https://modernjuliaworkflows.github.io/

Since Julia is supposed to be a modern language, it might make more sense to just call them “Common Julia workflows”?

I like that one. @jacobusmmsmit @hill ?

Efficient Julia workflows? Less frustrating Julia workflows?

I wish they were “Simple” Julia workflows…

Smart Julia Workflows Effective Julia Workflows

[image] PeterSimon: Effective Julia Workflows +1 Reminds me of the fantastic Scott Meyer’s Effective C++ books.

So I read the other post you had in the “write doc PRs not blog posts” post on why this is being done as a blog post. I understand the justification on your side, but I think an official blog post will still have limited discoverability, so the issue you mention here may not be fully mitigated until such information is contained in the docs, either under “Workflow Tips” or, ideally, as the beginning of a new document separate from the manual, accessible from the Julia website with one click. Perhaps a button next to “Documentation” – that would be a button that beginners will very likely click. If I’m a beginner, the list as it is right now is pretty overwhelming, since it’s not clear which ones provide large improvements vs. those that are incremental. IMO I wouldn’t consider anything in the “Optimizing code” section suitable for beginners. I’ll suggest the following tutorial which could be included as a separate feature. This will get people on the right track for the workflow instead of typing julia file.jl like they’re used to in Python. Everything else, like OhMyREPL and BenchmarkTools, are intermediate to advanced, done after the very basics have been figured out (OhMyREPL is best paired with startup.jl, and we should cater to new users who are not interested in performance optimizations). Step-by-step tutorial (Windows users) Install juliaup in the Windows store. (Link directly to it, not the Github page) Open PowerShell and type juliaup add 1.9 to install the latest 1.9 version. Type juliaup status to confirm which version you have installed. When new releases like 1.10 come out, simply type juliaup update to update to the latest version. In the start menu, click on Julia to open the REPL. You can pin this to the taskbar and use it as a calculator. If you want to use an editor, install VSCode with the Julia language plugin. Otherwise, you can use Jupyter or Pluto for notebooks. (Link to a comparison between Jupyter and Pluto) Below, we assume you’re using VSCode. If you are using juliaup, VSCode will automatically find the Julia installation for you – skip to step 5. Otherwise, if you installed the binaries directly from the website, do the following: In VSCode, enter Ctrl+, to open up the settings. In the top bar, type julia.executable. You’ll need to paste the filepath to the executable from there. If you used default installation settings, it should look something like this: C:/users/username/AppData/Local/Programs/Julia-1.9.2/bin/julia.exe Type Alt+J+O to open the REPL in VSCode. (J+O stands for “Julia open.”) Besides being able to run Julia code, the REPL has a built-in package manager (type ]), a help mode (type ?), and a shell mode (type ;). Probably the most important package is Revise.jl. Install it by typing ] to enter Pkg mode, and then type add Revise. This package will automatically update function definitions in a running Julia session. Since Julia has a relatively long startup time, for maximum convenience, we recommend keeping the current REPL session open for as long as possible. Unlike most packages, VSCode is set up to run Revise.jl upon starting up Julia. That way, you don’t need to type in using Revise every time you open the REPL. To run code, you have a few choices. To illustrate, create a new file called test.jl with the example code to print out powers of 2: a = 1:10 # defines a vector of the first 10 natural numbers b = 2 .^ a # defines a vector that takes the first 10 powers of 2. The dot indicates element-wise operation. [a b] # defines a matrix whose columns are a and b There are three choices you have to run this code: With the cursor on the window with the code, hit Ctrl+A+Enter to select all and execute the highlighted code to the REPL. Press the play button near the top of the screen to execute the active file in the REPL. Type include(“./test.jl”) into the REPL. Notice that in all of these, the last line is returned. Where does Revise come in? By default, the includet function that Revise exports will track changes to function definitions, not data. Since we didn’t define any functions, typing includet(“./test.jl”) won’t reflect changes if, say, we wanted a to go from 1 to 20. It is good practice to write our code in functions, especially for more complex code, so let’s define a function called main: function main() a = 1:10 b = 2 .^ a return [a b] end main() You can check that Ctrl+A+Enter works as usual. (If the main() at the end were not there, you would only be defining a function called main, but not actually running it. To run it, type main() in the REPL.) Now to check that Revise works, type includet(“./test.jl”). This will include the file and track any changes to main() as long as the REPL is running. Notice that nothing will be printed. That’s fine – in the REPL, type main() to display the result. Change the second line to a = 1:20. Save the file. Type main() again in the REPL. Revise detects that main() has changed, and the function now prints out the first 20 powers of 2. Lastly, my suggestion for the blog post title would be “Improving Julia workflows.”

[image] Ininterrompue: I understand the justification on your side, but I think an official blog post will still have limited discoverability, so the issue you mention here may not be fully mitigated until such information is contained in the docs, either under “Workflow Tips” or, ideally, as the beginning of a new document separate from the manual, accessible from the Julia website with one click. I agree, but while writing the blog I also discovered an additional benefit of doing it: putting all of these tips in a single place. I know of no other website containing that many resources in the same spot. And once we put them all in the documentation, they will probably much more scattered, but it helps to gather them first. Besides, it also prompted new developments, like improvements to Franklin.jl and PkgTemplates.jl, or the brand new StartupCustomizer.jl. [image] Ininterrompue: If I’m a beginner, the list as it is right now is pretty overwhelming, since it’s not clear which ones provide large improvements vs. those that are incremental. That’s why we ended up splitting the post in three pages. If you check out the preview at https://modernjuliaworkflows.github.io/, I try to make it clear that not everything should be read at once by a beginner. [image] Ininterrompue: I’ll suggest the following tutorial which could be included as a separate feature. This will get people on the right track for the workflow instead of typing julia file.jl like they’re used to in Python I agree that this is what we want as a priority, and it roughly corresponds to the first page of the blog (still being written :sweat_smile:). Thank you for your suggestions, I’ll add those if we missed some of them.

EDIT: Clearly, the question of whether to include “modern” is bikeshedding and isn’t worth more than perhaps one or two minutes’ thought. I agree that “Julia workflows” is boring, or lacks something. Take 1. On the other hand “Modern Julia xxx” always reminds of the Modern Perl stuff from several years ago that was meant in part to promote the idea that Perl is as real or as good a language as Python, which wasn’t really true. In any case it didn’t work. This isn’t a rational take, it’s more an involuntary association. Take 2. “Modern Python …” is all over the place, too. And you see old, non-optimal, Python practices persisting. If I were an intermediate Python programmer (maybe I am :)) I might hope to find an article with a title like this that was to the point and useful (good luck with that); in principle you might find one that was useful, in particular because of all of the out of date info on the web. Likewise, Julia has changed, and many people (myself included) would like to know of some state of the art workflows. Take 3. “Modern Python…” or (“Modern YYY”) is a marketing tactic to make your article stand out. Something that’s necessary because of the volume of Python stuff. In fact, if you search, you’ll find it’s not good enough. You need to read the series on “Hypermodern Python”. I don’t find a “supermodern” version. The author could be a francophone. Several years ago at least, in french it was common to jump right over “super” directly to “hyper”.

[Seeking feedback] Blog post about "Modern Julia workflows"?

Tooling

gdalle February 23, 2024, 3:00pm 37

Update: the second page of the blog (on package creation and sharing) is complete!

Topic		Replies	Views
Write documentation PRs not blog posts Teaching & Outreach discussion	36	3491	July 30, 2023
Too much time on my hands Community pkgtemplates	62	4601	July 14, 2025
Blog post about my experiences with Julia Community	258	20682	June 19, 2022
Julia is Ranked 35th on the TIOBE Index Community blog	49	7625	December 14, 2020
Non-friendly documentation New to Julia question , documentation	136	11168	September 18, 2020

[Seeking feedback] Blog post about "Modern Julia workflows"?

Related topics