Agate.jl

Aquatic Gcm-Agnostic Tunable Ecosystems

A Julia library to build flexible and composable aquatic ecosystems.

Note on maintenance and development

Agate.jl is currently under active development. While we welcome contributions, please be aware that the API and functionality may change as we continue to improve the package. We recommend checking the documentation and release notes regularly for updates.

Documentation

• DEV — documentation of the in-development version.

Getting started

Download Julia by following instructions at https://julialang.org/downloads/.

Clone this repository and change your current working directory to this project:

https://github.com/agate-model/Agate.jl.git
cd Agate.jl

To activate the project (this takes a while as it installs all the packages):

julia --project -e 'using Pkg; Pkg.instantiate()'

You can then use the package interactively, in the terminal:

julia --project=.

To run an example script:

julia --project <path to script>

To use the package in a Jupyter notebook run:

using Pkg
Pkg.activate("<path to Agate.jl repo>")

Development

We follow the Blue style guide for Julia. To automatically format all Julia files in the project you can use the JuliaFormatter. Once you have installed it (add JuliaFormatter) run:

using JuliaFormatter

format(".")

To update project dependencies:

] add <package>

To run tests:

] test