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

Jump to bottom

Require FourierFlows 0.9.2 #298

Merged
merged 4 commits into from
Aug 27, 2022
Merged

Require FourierFlows 0.9.2 #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5815238
fix minor typos
navidcy Aug 17, 2022
4613702
fix typo
navidcy Aug 17, 2022
b831d86
bump version to 0.14.2
navidcy Aug 17, 2022
a84da17
fix admonition
navidcy Aug 17, 2022
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributors Guide
# Contributors' Guide

Thank you for considering contributing to GeophysicalFlows.jl!

Expand Down
4 changes: 2 additions & 2 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "GeophysicalFlows"
uuid = "44ee3b1c-bc02-53fa-8355-8e347616e15e"
license = "MIT"
authors = ["Navid C. Constantinou <navidcy@gmail.com>", "Gregory L. Wagner <wagner.greg@gmail.com>", "and co-contributors"]
version = "0.14.1"
version = "0.14.2"

[deps]
CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
Expand All @@ -21,7 +21,7 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
CUDA = "^1, ^2.4.2, 3.0.0 - 3.6.4, ^3.7.1"
DocStringExtensions = "^0.8, 0.9"
FFTW = "^1"
FourierFlows = "^0.9"
FourierFlows = "^0.9.2"
JLD2 = "^0.1, ^0.2, ^0.3, ^0.4"
Reexport = "^0.2, ^1"
SpecialFunctions = "^0.10, ^1, 2"
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ if you'd like to work on a new feature or implement a new module, if you're new
and want to find a cool little project or issue to work on that fits your interests! We're more
than happy to help along the way.

For more information, check out our [contributor's guide](https://github.com/FourierFlows/GeophysicalFlows.jl/blob/main/CONTRIBUTING.md).
For more information, check out our [contributors' guide](https://github.com/FourierFlows/GeophysicalFlows.jl/blob/main/CONTRIBUTING.md).


[FourierFlows.jl]: https://github.com/FourierFlows/FourierFlows.jl
Expand Down
2 changes: 1 addition & 1 deletion docs/src/aliasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliasing errors in the [FourierFlows.jl Documentation](https://fourierflows.gith
in Fourier space before transforming to physical space to compute nonlinear terms.

!!! info "De-aliasing scheme"
FourierFlows.jl curently implements dealiasing by zeroing out the highest-`aliased_fraction`
FourierFlows.jl currently implements dealiasing by zeroing out the highest-`aliased_fraction`
wavenumber components on a `grid`. By default in FourierFlows.jl, `aliased_fraction=1/3`.
Users can construct a `grid` with different `aliased_fraction` via

Expand Down
2 changes: 1 addition & 1 deletion docs/src/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributors Guide
# Contributors' Guide

This is a short guide for potential GeophysicalFlows.jl contributors.

Expand Down
7 changes: 3 additions & 4 deletions docs/src/stochastic_forcing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ computation instead of using one of the two consistently all along.
All modules included in GeophysicalFlows.jl use **Stratonovich calculus**.

The choice of Stratonovich calculus for GeophysicalFlows.jl was made since this calculus "works
the same" with both stochastic and deterministic forcing, i.e. with Stratonovich calculus we
the same" with both stochastic and deterministic forcing, i.e., with Stratonovich calculus we
have the same chain rules for differentiation for stochastic functions as the chain rules we
learn in normal-deterministic calculus). Therefore, with the Stratonovich calculus the code
does not really "care" whether the user implement deterministic or stochastic forcing.

If you are interested in learning more regarding the two stochastic calculi and how they are
If you are interested in learning more regarding the two stochastic calculi and how they are
numerically implemented then read on; otherwise you can skip this section of the documentation.

## Stochastic Differential Equations (SDEs)
Expand Down Expand Up @@ -53,7 +53,7 @@ with ``W_t`` a Brownian motion or Wiener process, can be written in an integral
2. Stationarity. The statistical distribution of the increment ``W_{t+s} − W_s`` does not depend on ``s`` (and so is identical in distribution to ``W_t``).
3. Gaussianity. ``W_t`` is a Gaussian process with mean ``\langle W_t \rangle = 0`` and covariance ``\langle W_t W_s \rangle = \min(t, s)``.

!!! tip Notation, e.g., ``x_t``
!!! tip "Notation, e.g., ``x_t``"
It's common to use notation ``x_t`` to denote explicit ``t``-dependence of variable ``x``. Not to be confused with the other common usage of subscripts for denoting partial differentiation.

The last integral in the integral representation of a SDE expression above is a stochastic integral
Expand Down Expand Up @@ -259,7 +259,6 @@ Figure below compares the energy evolution as predicted by:
- time-integration of (3) using Euler--Maruyama, and
- time-integration of (4) using Euler--Heun.


```@setup 1
using Plots
Plots.default(lw=2)
Expand Down