SubzeroModule

Subzero.jl

Docs CI CodeCov Status

Fast and Flexible Sea Ice Dynamics

Subzero.jl is a native Julia discrete-element model (DEM) for exploring fine-scale sea ice dynamics, reimplementing and enhancing MATLAB model SubZero by Manucharyan and Montemuro.

  • 🚀 Runs over 35 times faster that original MATLAB model for title simulation!
  • 🧩 Modular simulation model makes it easy to customize simulations!
    • Enable and disable physical processes such as fracturing, ridging, and welding
    • Choose algorithms for key processes (or add your own!)

Documentation

To learn how to build and run simulations, check out our documentation and tutorials!

Installation

Subzero is not yet a registered Julia package. So to install it,

  1. Download Julia (version 1.9 or later).

  2. Launch Julia and enter into the package manager mode by typing ] in the terminal.

  3. Run the following

pkg> add "git@github.com:Caltech-OCTO/Subzero.jl.git"

This will add the package to your package manager. After that you return to the REPL mode by hitting the backspace and you are ready to use Subzero!

julia> using Subzero

Citing

If you use Subzero.jl as part of your research, teaching, or other activities, we would be grateful if you could cite our work. We are currently working on a JOSS paper, which will be linked here. If you are ready to publish before that, please reach out to us to discuss citations.

Contributing

If you’re interested in contributing to the development Subzero, we would love to have you! We welcome all kinds of contributions from bug reports, to documentation, to features, and suggestions. We can't wait to talk to you.

Please check out our contributers' guide for more details.

Authors

The list of Subzero contributors:

Contributers

source