From 581523872560898e65b55ca7519f762f689bd52b Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Wed, 17 Aug 2022 21:20:29 +1000 Subject: [PATCH 1/4] fix minor typos --- CONTRIBUTING.md | 2 +- docs/src/aliasing.md | 2 +- docs/src/contributing.md | 2 +- docs/src/stochastic_forcing.md | 5 ++--- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59f20556..330a5771 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributors Guide +# Contributors' Guide Thank you for considering contributing to GeophysicalFlows.jl! diff --git a/docs/src/aliasing.md b/docs/src/aliasing.md index 7e56db76..fac8a21b 100644 --- a/docs/src/aliasing.md +++ b/docs/src/aliasing.md @@ -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 diff --git a/docs/src/contributing.md b/docs/src/contributing.md index 5e035975..4c3c169c 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -1,4 +1,4 @@ -# Contributors Guide +# Contributors' Guide This is a short guide for potential GeophysicalFlows.jl contributors. diff --git a/docs/src/stochastic_forcing.md b/docs/src/stochastic_forcing.md index 5e515ccf..6c45491e 100644 --- a/docs/src/stochastic_forcing.md +++ b/docs/src/stochastic_forcing.md @@ -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) @@ -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) From 4613702e46fa9193984fba9bd9cad88bc79e7403 Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Wed, 17 Aug 2022 21:20:54 +1000 Subject: [PATCH 2/4] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 13fb914a..7b211aac 100644 --- a/README.md +++ b/README.md @@ -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 From b831d860867f4377a2c7dd608b07685458a661ed Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Wed, 17 Aug 2022 21:20:54 +1000 Subject: [PATCH 3/4] bump version to 0.14.2 --- Project.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Project.toml b/Project.toml index 48fe837a..d8e56b02 100644 --- a/Project.toml +++ b/Project.toml @@ -2,7 +2,7 @@ name = "GeophysicalFlows" uuid = "44ee3b1c-bc02-53fa-8355-8e347616e15e" license = "MIT" authors = ["Navid C. Constantinou ", "Gregory L. Wagner ", "and co-contributors"] -version = "0.14.1" +version = "0.14.2" [deps] CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba" @@ -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" From a84da174848aabb72a31b1a7408abdfb604f4654 Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Wed, 17 Aug 2022 21:31:02 +1000 Subject: [PATCH 4/4] fix admonition --- docs/src/stochastic_forcing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/stochastic_forcing.md b/docs/src/stochastic_forcing.md index 6c45491e..d917465c 100644 --- a/docs/src/stochastic_forcing.md +++ b/docs/src/stochastic_forcing.md @@ -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