Skip to content

Caltech-OCTO/Subzero.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 a registered Julia package. So to install it,

  1. Download Julia (version 1.10 or later). We recommend using JuliaUp so it is easy to change versions in the future.

  2. Launch Julia and type

    julia> using Pkg
    
    julia> Pkg.add("Subzero")

    This installs the latest version that's compatible with your current environment.

  3. You are ready to use Subzero! Get started with:

    julia> using Subzero

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 see CONTRIBUTING for more details.

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.

Authors

The list of Subzero contributors:

Contributers

About

Native Julia Discrete Element Sea Ice Model

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages