Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/RJArthern/WAVI.jl

WAVI ice sheet model
https://github.com/RJArthern/WAVI.jl

Last synced: about 1 month ago
JSON representation

WAVI ice sheet model

Host: GitHub
URL: https://github.com/RJArthern/WAVI.jl
Owner: RJArthern
License: mit
Created: 2020-08-06T17:31:05.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-05-13T13:12:43.000Z (4 months ago)
Last Synced: 2024-05-19T14:20:58.696Z (4 months ago)
Language: Julia
Homepage: https://rjarthern.github.io/WAVI.jl/
Size: 18.6 MB
Stars: 26
Watchers: 3
Forks: 7
Open Issues: 19
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

open-sustainable-technology - WAVI.jl - A fast and friendly ice sheet model, written in Julia. (Cryosphere / Glacier and Ice Sheets)

README

        


  ☃️🏔️❄️ WAVI.jl ❄️🏔️☃️





  



WAVI (Wavelet-based Adaptive-grid Vertically-integrated Ice-model) is a fast and friendly ice sheet model, written in Julia. WAVI documentation can be found [here](https://rjarthern.github.io/WAVI.jl/).

![Testing](https://github.com/RJArthern/WAVI.jl/actions/workflows/Testing.yml/badge.svg?docs-reconcile)

![Documentation](https://github.com/RJArthern/WAVI.jl/actions/workflows/Documentation.yml/badge.svg?docs-reconcile)

## Contents

* [Installation instructions](#installation-instructions)

* [Running your first model](#running-your-first-model)

* [Getting help](#getting-help)

* [Contributing](#contributing)

* [Credits](#credits)

## Installation instructions

You can install the latest version of WAVI using Julia's in-build package manager:

```julia

julia>using Pkg

julia>Pkg.add(PackageSpec(url="https://github.com/RJArthern/WAVI.jl.git", rev = "main"))

```

Note that WAVI requires Julia v1.5 or newer.

Updating WAVI is also achieved using the package manager

```julia

julia>using Pkg

julia>Pkg.update("WAVI"))

```

Note that updating should be done with care as WAVI is still developing rapidly; while we aim to keep breaking changes to a minimum, this cannot be guaranteed at present.

## Running your first model

Let's run the MISMIP+ experiment (http://www.climate-cryosphere.org/activities/targeted/153-misomip/1412-mismip-plus), the latest ice sheet model intercomparison experiment. We'll use a grid with 80x10 grid points and 8km resolution in both dimensions, and 4 vertical levels. We'll run the model to steady state for 10000 years with a timestep of 0.5 years. Since we're only interested in the steady state, we'll speed up the code by only doing one iteration of the velocity solve per timestep:

```julia

using WAVI 

grid = Grid(nx = 80, ny = 10, nσ = 4, dx = 8000., dy = 8000., u_iszero = ["north"], v_iszero = ["east", "west"])

bed = WAVI.mismip_plus_bed 

params = Params(accumulation_rate = 0.3)

solver_params =  SolverParams(maxiter_picard = 1)

model = Model(grid = grid,bed_elevation = bed, params = params)

timestepping_params = TimesteppingParams(dt = 0.5, end_time = 10000.)

simulation = Simulation(model = model, timestepping_params = timestepping_params)

run_simulation!(simulation)

```

It's as easy as that: entry into the state of the art ice sheet model intercomparison in nine lines of code 😎

## Getting help

## Contributing

If you're interested in contributing to the development of WAVI we want your help no matter how big or small a contribution you make! Contributing guidelines can be found in our [contributing guide](https://rjarthern.github.io/WAVI.jl/contributing/)

## Credits

This package was initiated by Rob Arthern (https://github.com/RJArthern) and is currently maintained by Rob and Alex Bradley (https://github.com/alextbradley)