From 78d5ce22c48e37be6aee401ee7836b236aae6231 Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Fri, 10 Nov 2023 18:53:10 -0800 Subject: [PATCH] add installation instructions --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d51d25af..1fa0da41 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,17 @@ [![Build status](https://badge.buildkite.com/3113cca353b83df3b5855d3f0d69827124614aef7017c835d2.svg)](https://buildkite.com/clima/climaocean-ci) Ocean component for CliMa's Earth system model based on Oceananigans. + +## Installation + +To install from a Julia REPL: + +```julia +julia> ] + +pkg> add https://github.com/CliMA/ClimaOcean.jl.git + +pkg> instantiate +``` + +You can add `#main` to add the latest from `main` branch or `@vX.X` to install a tagged release.