Caltech-OCTO / Subzero.jl

Native Julia Discrete Element Sea Ice Model
MIT License
5 stars 1 forks source link

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.

Documentation

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

Installation

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

  1. Download Julia (version 1.9 or later).

  2. Launch Julia and type

julia> using Pkg

julia> Pkg.add("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