Installation and getting started with Oceananigans

Oceananigans installation is "often" simple

Sure, Oceananigans is "easy to use", but is it "easy to install"? In the majority of cases, installing Oceananigans "just" requires installing Julia, starting Julia, and typing

julia> using Pkg

julia> Pkg.add("Oceananigans")

(For more information about installing packages in Julia, see the Pkg documentation.)

For the rest of us --- users who are new to Julia, users with non-standard hardware, or users who are simply new to text editing Unicode characters --- this wiki page is for you.

Installing Julia

Most users are able to install Julia by downloading a pre-built binary. If a pre-built binary is not available for your system (for example, if you're on a POWER9 system), you may need to build Julia from source. But don't worry --- building Julia from source is often as painless as downloading a pre-built binary.

Programming in Julia

All users of Oceananigans benefit from basic Julia programming knowledge. The internet abounds with resources and tutorials for getting started with Julia --- we recommend starting here!

Editing text files

If you're totally new to programming, we recommend editing text with VSCode and using the VSCode extension for Julia.

There's also unicode and Julia syntax support for vim.