Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readme #26

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Fix readme #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
bt_ocean
========

bt_ocean is a differentiable pseudospectral solver for the barotropic vorticity
equation on a beta-plane, for classic wind-forced barotropic ocean gyre
simulations.
bt_ocean is a differentiable finite difference solver for the barotropic
vorticity equation on a beta-plane, for classic wind-forced barotropic ocean
gyre simulations.

bt_ocean is designed to be simple, lightweight, and fast on a single GPU. The
aim is enable rapid testing of ocean-relevant machine learning techniques in a
Expand All @@ -13,7 +13,7 @@ backscatter.
Features
--------

- A pseudospectral solver for the 2D barotropic vorticity equation in a
- A finite difference solver for the 2D barotropic vorticity equation in a
rectangular domain, for simulations of classic wind-driven Munk-Stommel ocean
gyre problems.
- Uses the JAX library, providing GPU and autodiff support.
Expand Down