WAVI.jl
A fast and friendly ice sheet model, written in Julia.
https://github.com/wavi-ice-sheet-model/wavi.jl
Last synced: 2 days ago
JSON representation
Acceptance Criteria
- Revelant topics? false
- External users? true
- Open source license? true
- Active? true
- Fork? false
Repository metadata
WAVI ice sheet model
- Host: GitHub
- URL: https://github.com/wavi-ice-sheet-model/wavi.jl
- Owner: WAVI-ice-sheet-model
- License: mit
- Created: 2020-08-06T17:31:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-26T11:37:38.000Z (28 days ago)
- Last Synced: 2025-12-09T06:24:09.729Z (16 days ago)
- Language: Julia
- Homepage: https://wavi-ice-sheet-model.github.io/WAVI.jl/
- Size: 19.1 MB
- Stars: 32
- Watchers: 3
- Forks: 12
- Open Issues: 44
- Releases: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
README.md
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.
Contents
Installation instructions
You can install the latest version of WAVI using Julia's in-build package manager:
julia>using Pkg
julia>Pkg.add(PackageSpec(url="https://github.com/WAVI-ice-sheet-model/WAVI.jl.git", rev = "main"))
Note that WAVI requires Julia v1.5 or newer.
Updating WAVI is also achieved using the package manager
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:
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
Building documentation
If working on developing the codebase, you can build the documentation locally using:
julia docs/serve.jl
or:
./docs/serve.jl
And optionally, using the --live flag to enable hot-reloading, which will reload the browser upon any changes in the markdown, or source code (including docstrings).
./docs/serve.jl --live
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
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)
Owner metadata
- Name: WAVI-ice-sheet-model
- Login: WAVI-ice-sheet-model
- Email:
- Kind: organization
- Description:
- Website:
- Location: United Kingdom
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/227185268?v=4
- Repositories: 1
- Last ynced at: 2025-08-19T11:42:13.507Z
- Profile URL: https://github.com/WAVI-ice-sheet-model
GitHub Events
Total
- Create event: 4
- Release event: 1
- Issues event: 13
- Watch event: 1
- Issue comment event: 7
- Push event: 11
- Pull request review comment event: 1
- Pull request review event: 6
- Pull request event: 4
- Fork event: 1
Last Year
- Create event: 4
- Release event: 1
- Issues event: 13
- Watch event: 1
- Issue comment event: 7
- Push event: 11
- Pull request review comment event: 1
- Pull request review event: 6
- Pull request event: 4
- Fork event: 1
Committers metadata
Last synced: 9 days ago
Total Commits: 481
Total Committers: 9
Avg Commits per committer: 53.444
Development Distribution Score (DDS): 0.387
Commits in past year: 75
Committers in past year: 3
Avg Commits per committer in past year: 25.0
Development Distribution Score (DDS) in past year: 0.493
| Name | Commits | |
|---|---|---|
| Alex Bradley | 3****y | 295 |
| RJArthern | r****t@b****k | 69 |
| thomaszwagerman | t****a@b****k | 38 |
| James Byrne | j****n@g****m | 25 |
| Charlotte Williams | c****1@b****k | 18 |
| C Rosie Williams | c****1@b****k | 15 |
| Bryn Noel Ubald | 5****d | 12 |
| David-Bett4 | 5****4 | 8 |
| pierthodo | p****o@g****m | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 26 days ago
Total issues: 14
Total pull requests: 6
Average time to close issues: about 2 months
Average time to close pull requests: about 1 month
Total issue authors: 5
Total pull request authors: 2
Average comments per issue: 0.43
Average comments per pull request: 0.83
Merged pull request: 3
Bot issues: 0
Bot pull requests: 0
Past year issues: 14
Past year pull requests: 6
Past year average time to close issues: about 2 months
Past year average time to close pull requests: about 1 month
Past year issue authors: 5
Past year pull request authors: 2
Past year average comments per issue: 0.43
Past year average comments per pull request: 0.83
Past year merged pull request: 3
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- thomaszwagerman (5)
- JimCircadian (4)
- bnubald (2)
- miradhkri (2)
- alextbradley (1)
Top Pull Request Authors
- thomaszwagerman (5)
- JimCircadian (1)
Top Issue Labels
- documentation (5)
- enhancement (3)
- bug (3)
Top Pull Request Labels
- enhancement (1)
Dependencies
- actions/checkout v2 composite
- julia-actions/setup-julia v1 composite
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action v.1.0 composite
- julia 1.6 build
Score: 6.527957917622551