Installation

EnsembleKalmanProcesses.jl is a registered Julia package. It is compatible with Julia 1.5 or newer (we recommend the latest LTS release or newer). You can install the latest version of EnsembleKalmanProcesses.jl through the built-in package manager. Press ] in the Julia REPL command prompt and

julia> ]
pkg> add EnsembleKalmanProcesses

This will install the latest tagged release of the package.

But I wanna be on the bleeding edge...

If you want the most recent developer's version of the package then

julia> ]
pkg> add EnsembleKalmanProcesses#main

You can run the tests via the package manager by:

julia> ]
pkg> test EnsembleKalmanProcesses

Cloning the repository

If you are interested in getting your hands dirty and modifying the code then, you can also clone the repository and then instantiate, e.g.,

> git clone https://github.com/CliMA/EnsembleKalmanProcesses.jl.git
> cd EnsembleKalmanProcesses.jl
> julia --project -e 'using Pkg; Pkg.instantiate()'

Do I need to clone the repository?

Most times, cloning the repository is not necessary. If you only want to use the package's functionality, adding the packages as a dependency on your project is enough.

Running the test suite

You can run the package's tests:

> julia --project -e 'using Pkg; Pkg.test()'

Alternatively, you can do this from within the repository:

> julia --project
julia> ]
(EnsembleKalmanProcesses) pkg> test

Building the documentation locally

Once the project is built, you can build the project documentation under the docs/ sub-project:

> julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
> julia --project=docs/ docs/make.jl

The locally rendered HTML documentation can be viewed at docs/build/index.html

Running repository examples

We have a selection of examples, found within the examples/ directory to demonstrate different use of our toolbox. Each example directory contains a Project.toml

To build with the latest EnsembleKalmanProcesses.jl release:

> cd examples/example-name/
> julia --project -e 'using Pkg; Pkg.instantiate()'
> julia --project example-file-name.jl

If you wish to run a local modified version of EnsembleKalmanProcesses.jl then try the following (starting from the EnsembleKalmanProcesses.jl package root)

> cd examples/example-name/
> julia --project 
julia> ]
(example-name)> rm EnsembleKalmanProcesses
(example-name)> dev ../..

followed by

> julia --project example-file-name.jl